diff --git a/packages/ibm-products/src/components/APIKeyModal/APIKeyModal.docs-page.js b/packages/ibm-products/src/components/APIKeyModal/APIKeyModal.docs-page.js index 024a70f7f9e..9373d3e82f4 100644 --- a/packages/ibm-products/src/components/APIKeyModal/APIKeyModal.docs-page.js +++ b/packages/ibm-products/src/components/APIKeyModal/APIKeyModal.docs-page.js @@ -7,23 +7,23 @@ import React from 'react'; import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage'; -import { useOf } from '@storybook/blocks'; -import { storyDocsGuidelines } from '../../global/js/utils/story-helper'; + import * as stories from './APIKeyModal.stories'; const DocsPage = () => { - const { csfFile } = useOf('meta', ['meta']); - return ( ( , + }, }, decorators: [(story) => {story()}], }; diff --git a/packages/ibm-products/src/components/Cascade/Cascade.docs-page.js b/packages/ibm-products/src/components/Cascade/Cascade.docs-page.js index 37469322e5f..950d398fddc 100644 --- a/packages/ibm-products/src/components/Cascade/Cascade.docs-page.js +++ b/packages/ibm-products/src/components/Cascade/Cascade.docs-page.js @@ -8,19 +8,18 @@ import React from 'react'; import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage'; import * as stories from './Cascade.stories'; -import { useOf } from '@storybook/blocks'; -import { storyDocsGuidelines } from '../../global/js/utils/story-helper'; const DocsPage = () => { - const { csfFile } = useOf('meta', ['meta']); - return ( ( { altGuidelinesHref={[ { href: 'https://pages.github.ibm.com/carbon/ibm-products/patterns/create-flows/usage/#side-panel', - label: 'Carbon create flows side panel usage guidelines', + label: 'CreateSidePanel usage guidelines', }, ]} blocks={[ diff --git a/packages/ibm-products/src/components/DataSpreadsheet/DataSpreadsheet.mdx b/packages/ibm-products/src/components/DataSpreadsheet/DataSpreadsheet.mdx index 0126c01b92b..e0a5ae5bb52 100644 --- a/packages/ibm-products/src/components/DataSpreadsheet/DataSpreadsheet.mdx +++ b/packages/ibm-products/src/components/DataSpreadsheet/DataSpreadsheet.mdx @@ -5,6 +5,8 @@ import * as stories from './DataSpreadsheet.stories'; # DataSpreadsheet +[DataSpreadsheet usage guidelines](https://pages.github.ibm.com/carbon/ibm-products/components/data-spreadsheet/usage/) + ## Table of Contents - [Overview](#overview) diff --git a/packages/ibm-products/src/components/DelimitedList/DelimitedList.docs-page.js b/packages/ibm-products/src/components/DelimitedList/DelimitedList.docs-page.js index 0d0d4235c0b..24491db39f6 100644 --- a/packages/ibm-products/src/components/DelimitedList/DelimitedList.docs-page.js +++ b/packages/ibm-products/src/components/DelimitedList/DelimitedList.docs-page.js @@ -12,6 +12,7 @@ import * as stories from './DelimitedList.stories'; export const DocsPage = () => ( ( ( diff --git a/packages/ibm-products/src/components/EmptyStates/ErrorEmptyState/ErrorEmptyState.stories.jsx b/packages/ibm-products/src/components/EmptyStates/ErrorEmptyState/ErrorEmptyState.stories.jsx index 592d4423380..4115b2ffb15 100644 --- a/packages/ibm-products/src/components/EmptyStates/ErrorEmptyState/ErrorEmptyState.stories.jsx +++ b/packages/ibm-products/src/components/EmptyStates/ErrorEmptyState/ErrorEmptyState.stories.jsx @@ -25,13 +25,9 @@ export default { page: () => ( diff --git a/packages/ibm-products/src/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.stories.jsx b/packages/ibm-products/src/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.stories.jsx index 3b4cd4ea600..fd5e83097ac 100644 --- a/packages/ibm-products/src/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.stories.jsx +++ b/packages/ibm-products/src/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.stories.jsx @@ -25,13 +25,9 @@ export default { page: () => ( diff --git a/packages/ibm-products/src/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.stories.jsx b/packages/ibm-products/src/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.stories.jsx index 0b3ffbdcc21..5b9b7926153 100644 --- a/packages/ibm-products/src/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.stories.jsx +++ b/packages/ibm-products/src/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.stories.jsx @@ -25,13 +25,9 @@ export default { page: () => ( diff --git a/packages/ibm-products/src/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.stories.jsx b/packages/ibm-products/src/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.stories.jsx index 2c3eab81dfe..079e47eee2b 100644 --- a/packages/ibm-products/src/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.stories.jsx +++ b/packages/ibm-products/src/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.stories.jsx @@ -24,13 +24,9 @@ export default { page: () => ( diff --git a/packages/ibm-products/src/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.stories.jsx b/packages/ibm-products/src/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.stories.jsx index d14b9258a97..ab6d58c6c99 100644 --- a/packages/ibm-products/src/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.stories.jsx +++ b/packages/ibm-products/src/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.stories.jsx @@ -24,13 +24,9 @@ export default { page: () => ( diff --git a/packages/ibm-products/src/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.stories.jsx b/packages/ibm-products/src/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.stories.jsx index c259d147ca8..b7098d584ce 100644 --- a/packages/ibm-products/src/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.stories.jsx +++ b/packages/ibm-products/src/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.stories.jsx @@ -24,13 +24,9 @@ export default { page: () => ( diff --git a/packages/ibm-products/src/components/ExportModal/ExportModal.stories.jsx b/packages/ibm-products/src/components/ExportModal/ExportModal.stories.jsx index 6977ccc698e..40142798557 100644 --- a/packages/ibm-products/src/components/ExportModal/ExportModal.stories.jsx +++ b/packages/ibm-products/src/components/ExportModal/ExportModal.stories.jsx @@ -7,9 +7,7 @@ import React, { useState, useRef } from 'react'; import { Button } from '@carbon/react'; -// import styles from './_storybook-styles.scss?inline'; // import index in case more files are added later. import { ExportModal } from '.'; -// import mdx from './ExportModal.mdx'; import wait from '../../global/js/utils/wait'; import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage'; @@ -18,21 +16,20 @@ export default { component: ExportModal, tags: ['autodocs'], parameters: { - // styles, docs: { page: () => ( ( ( { label: 'Carbon Modal usage guidelines', }, { - href: 'https://react.carbondesignsystem.com/?path=/docs/modal--default', + href: 'https://react.carbondesignsystem.com/?path=/docs/components-modal', label: 'Carbon Modal documentation', }, ]} diff --git a/packages/ibm-products/src/components/InlineTip/InlineTip.docs-page.js b/packages/ibm-products/src/components/InlineTip/InlineTip.docs-page.js index 071c0b15aa2..68b0bc396ef 100644 --- a/packages/ibm-products/src/components/InlineTip/InlineTip.docs-page.js +++ b/packages/ibm-products/src/components/InlineTip/InlineTip.docs-page.js @@ -12,6 +12,12 @@ import * as stories from './InlineTip.stories'; const DocsPage = () => ( ( { - const { csfFile } = useOf('meta', ['meta']); - return ( */} - -import { Story, Controls, Canvas } from '@storybook/addon-docs'; -import { Saving } from '.'; -import { CodesandboxLink } from '../../global/js/utils/story-helper'; -import * as stories from './Saving.stories'; - -# Saving - -[Usage guidelines](https://pages.github.ibm.com/carbon/ibm-products/patterns/saving/usage/) - -## Manual type - - - - - -## Auto type - - - - - -## Code sample - - - -## Component API - - diff --git a/packages/ibm-products/src/components/Saving/Saving.stories.jsx b/packages/ibm-products/src/components/Saving/Saving.stories.jsx index ccdf7c5d615..c2f171a93e4 100644 --- a/packages/ibm-products/src/components/Saving/Saving.stories.jsx +++ b/packages/ibm-products/src/components/Saving/Saving.stories.jsx @@ -8,7 +8,7 @@ import React, { useState, useEffect } from 'react'; import styles from './_storybook-styles.scss?inline'; // import index in case more files are added later. import { Saving } from '.'; -// import mdx from './Saving.mdx'; +import { StoryDocsPage } from '../../global/js/utils/StoryDocsPage'; import wait from '../../global/js/utils/wait'; import { TextArea } from '@carbon/react'; @@ -18,11 +18,11 @@ export default { tags: ['autodocs'], parameters: { styles, - /* -docs: { - page: mdx, + docs: { + page: () => ( + + ), }, -*/ }, argTypes: { successful: { diff --git a/packages/ibm-products/src/components/SearchBar/SearchBar.mdx b/packages/ibm-products/src/components/SearchBar/SearchBar.mdx index 7ba8d5b6a62..137dd742d53 100644 --- a/packages/ibm-products/src/components/SearchBar/SearchBar.mdx +++ b/packages/ibm-products/src/components/SearchBar/SearchBar.mdx @@ -5,6 +5,8 @@ import * as SearchBarStories from './SearchBar.stories'; # SearchBar +[Carbon Search pattern](https://carbondesignsystem.com/patterns/search-pattern/) + ## Table of Contents - [Overview](#overview) diff --git a/packages/ibm-products/src/components/StatusIcon/StatusIcon.docs-page.js b/packages/ibm-products/src/components/StatusIcon/StatusIcon.docs-page.js index 705388c663e..8c43251b983 100644 --- a/packages/ibm-products/src/components/StatusIcon/StatusIcon.docs-page.js +++ b/packages/ibm-products/src/components/StatusIcon/StatusIcon.docs-page.js @@ -11,6 +11,12 @@ import * as stories from './StatusIcon.stories'; const DocsPage = () => ( ( + + ), + }, }, argTypes: { containerWidth: { diff --git a/packages/ibm-products/src/components/Toolbar/Toolbar.mdx b/packages/ibm-products/src/components/Toolbar/Toolbar.mdx index d5bbe5cb857..9fac6000265 100644 --- a/packages/ibm-products/src/components/Toolbar/Toolbar.mdx +++ b/packages/ibm-products/src/components/Toolbar/Toolbar.mdx @@ -5,6 +5,8 @@ import * as stories from './Toolbar.stories'; # Toolbar +[Toolbar usage guidelines](https://pages.github.ibm.com/carbon/ibm-products/components/toolbar/usage/) + ## Table of Contents - [Overview](#overview) diff --git a/packages/ibm-products/src/components/UserAvatar/UserAvatar.mdx b/packages/ibm-products/src/components/UserAvatar/UserAvatar.mdx index ef13c7de052..4115bdf6faf 100644 --- a/packages/ibm-products/src/components/UserAvatar/UserAvatar.mdx +++ b/packages/ibm-products/src/components/UserAvatar/UserAvatar.mdx @@ -5,6 +5,8 @@ import * as UserAvatarStories from './UserAvatar.stories'; # UserAvatar +[UserAvatar usage guidelines](https://pages.github.ibm.com/carbon/ibm-products/components/user-avatar/usage/) + ## Table of Contents - [Overview](#overview) @@ -13,10 +15,11 @@ import * as UserAvatarStories from './UserAvatar.stories'; ## Overview -User avatars are a representation of a user or group of users. They can be used to identify a user or indicate collaborators. -By default the component will display `name` on a 'order-1-cyan' background if name exist else it will render a user icon. -UserAvatar allows an image of the user to be displayed by passing in the `image` prop as well as customizing icons using `renderIcon` prop. - +User avatars are a representation of a user or group of users. They can be used +to identify a user or indicate collaborators. By default the component will +display `name` on a 'order-1-cyan' background if name exist else it will render +a user icon. UserAvatar allows an image of the user to be displayed by passing +in the `image` prop as well as customizing icons using `renderIcon` prop. ## Migration from `UserProfileImage` @@ -41,9 +44,9 @@ table below to see the new specifications. ## Note on theming -The user avatar supports all the 4 theme variants from carbon (white, g10, g90 and g100). -The backgroundColor and font color will adapt dynamically based on the lighter and darker themes. - +The user avatar supports all the 4 theme variants from carbon (white, g10, g90 +and g100). The backgroundColor and font color will adapt dynamically based on +the lighter and darker themes. ## Example usage diff --git a/packages/ibm-products/src/components/UserProfileImage/UserProfileImage.docs-page.js b/packages/ibm-products/src/components/UserProfileImage/UserProfileImage.docs-page.js index ff88241e697..6b5929d8ebf 100644 --- a/packages/ibm-products/src/components/UserProfileImage/UserProfileImage.docs-page.js +++ b/packages/ibm-products/src/components/UserProfileImage/UserProfileImage.docs-page.js @@ -11,6 +11,7 @@ import * as stories from './UserProfileImage.stories'; const DocsPage = () => (