From 92e0500f640cc7320bc83ba6d2efa5aef7647578 Mon Sep 17 00:00:00 2001 From: Taylor Jones Date: Thu, 29 Jul 2021 12:12:46 -0500 Subject: [PATCH] docs(grid): correct import paths, remove controls warning (#9202) Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com> --- packages/carbon-react/src/components/Grid/Grid.mdx | 12 ++++++------ .../carbon-react/src/components/Grid/Grid.stories.js | 12 ++++-------- 2 files changed, 10 insertions(+), 14 deletions(-) diff --git a/packages/carbon-react/src/components/Grid/Grid.mdx b/packages/carbon-react/src/components/Grid/Grid.mdx index a3d92d7d5013..74f2b8bb448b 100644 --- a/packages/carbon-react/src/components/Grid/Grid.mdx +++ b/packages/carbon-react/src/components/Grid/Grid.mdx @@ -35,10 +35,10 @@ Carbon's grid components help developers use the [2x Grid](https://www.carbondesignsystem.com/guidelines/2x-grid/overview). The project provides `Grid` and `Column` components which can be used to build a variety of layouts. You can import these components from -`carbon-components-react`: +`@carbon/react`: ```js -import { Grid, Column } from 'carbon-components-react'; +import { Grid, Column } from '@carbon/react'; ``` @@ -65,7 +65,7 @@ number `4` to specify that each `Column` component should span 4 columns at that breakpoint. ```js -import { Grid, Column } from 'carbon-components-react'; +import { Grid, Column } from '@carbon/react'; function MyComponent() { return ( @@ -79,7 +79,7 @@ function MyComponent() { } ``` -_Note: by default, `carbon-components` ships with a 16 column grid._ +_Note: by default, `@carbon/styles` ships with a 16 column grid._ You can pair up multiple breakpoint props to specify how many columns the `Column` component should span at different break points. In the example below, @@ -216,7 +216,7 @@ to a `section`. Simililarly, we use the `as` prop on `Column` to change it from a `div` to an `article`. ```jsx -import { Grid, Column } from 'carbon-components-react'; +import { Grid, Column } from '@carbon/react'; function MyComponent() { return ( @@ -234,7 +234,7 @@ You can also provide a custom component to the `as` prop. This custom component should accept all props passed to it, like a class name for the column. ```jsx -import { Grid, Column } from 'carbon-components-react'; +import { Grid, Column } from '@carbon/react'; function Article({ children, ...rest }) { return
{children}
; diff --git a/packages/carbon-react/src/components/Grid/Grid.stories.js b/packages/carbon-react/src/components/Grid/Grid.stories.js index 7ccd37cbc441..ab427958895c 100644 --- a/packages/carbon-react/src/components/Grid/Grid.stories.js +++ b/packages/carbon-react/src/components/Grid/Grid.stories.js @@ -28,18 +28,14 @@ export default { ), ], parameters: { + controls: { + include: [], // ensure props are not displayed on the controls pane + hideNoControlsWarning: true, + }, docs: { page: mdx, }, }, - argTypes: { - narrow: { - control: false, - }, - condensed: { - control: false, - }, - }, }; export const Wide = () => {