Skip to content

Commit

Permalink
Add migration note to Heading - Feature/ds 374 (#468)
Browse files Browse the repository at this point in the history
  • Loading branch information
fraincs authored Oct 2, 2024
2 parents 8ca1d3b + ae578a8 commit 69c1608
Show file tree
Hide file tree
Showing 40 changed files with 57 additions and 0 deletions.
4 changes: 4 additions & 0 deletions apps/docs/content/components/content/Heading.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,7 @@ You can alter the size of a heading to match the parent element's type scale by

TODO: Example of creating a custom version of this component
</FeatureFlag>

## Migration Notes

<MigrateGuide src="typography/Heading/docs/migration-notes" />
1 change: 1 addition & 0 deletions apps/docs/datas/components/Badge.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"tags":{},"filePath":"/packages/components/src/Badge/src/Badge.tsx","description":"","displayName":"Badge","methods":[],"props":{"variant":{"defaultValue":{"value":"\"primary\""},"description":"The visual style of the badge.","name":"variant","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"BadgeProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"BadgeProps"}],"required":false,"type":{"name":"BadgeVariant"}},"isDisabled":{"defaultValue":null,"description":"Whether or not the badge is disabled.","name":"isDisabled","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"BadgeProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"BadgeProps"}],"required":false,"type":{"name":"boolean"}},"isIndeterminate":{"defaultValue":null,"description":"Whether or not the badge is indeterminate and should just be a dot. This will ignore any children.","name":"isIndeterminate","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"BadgeProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"BadgeProps"}],"required":false,"type":{"name":"boolean"}},"aria-label":{"defaultValue":null,"description":"Defines a string value that labels the current element.","name":"aria-label","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"}],"required":false,"type":{"name":"string"}},"aria-labelledby":{"defaultValue":null,"description":"Identifies the element (or elements) that labels the current element.","name":"aria-labelledby","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"}],"required":false,"type":{"name":"string"}},"aria-describedby":{"defaultValue":null,"description":"Identifies the element (or elements) that describes the object.","name":"aria-describedby","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"}],"required":false,"type":{"name":"string"}},"aria-details":{"defaultValue":null,"description":"Identifies the element (or elements) that provide a detailed, extended description for the object.","name":"aria-details","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"}],"required":false,"type":{"name":"string"}},"slot":{"defaultValue":null,"description":"A slot name for the component. Slots allow the component to receive props from a parent component.\nAn explicit `null` value indicates that the local props completely override all props received from a parent.","name":"slot","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"SlotProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"SlotProps"}],"required":false,"type":{"name":"string | null"}},"children":{"defaultValue":null,"description":"The children of the component. A function may be provided to alter the children based on component state.","name":"children","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"RenderProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"RenderProps"}],"required":false,"type":{"name":"ReactNode | ((values: BadgeRenderProps & { defaultChildren: ReactNode; }) => ReactNode)"}},"className":{"defaultValue":null,"description":"The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state.","name":"className","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"StyleRenderProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"StyleRenderProps"}],"required":false,"type":{"name":"string | ((values: BadgeRenderProps & { defaultClassName: string; }) => string)"}},"style":{"defaultValue":null,"description":"The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.","name":"style","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"StyleRenderProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"StyleRenderProps"}],"required":false,"type":{"name":"CSSProperties | ((values: BadgeRenderProps & { defaultStyle: CSSProperties; }) => CSSProperties)"}}},"groups":{"default":{"variant":{"defaultValue":{"value":"\"primary\""},"description":"The visual style of the badge.","name":"variant","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"BadgeProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"BadgeProps"}],"required":false,"type":{"name":"BadgeVariant"}},"isDisabled":{"defaultValue":null,"description":"Whether or not the badge is disabled.","name":"isDisabled","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"BadgeProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"BadgeProps"}],"required":false,"type":{"name":"boolean"}},"isIndeterminate":{"defaultValue":null,"description":"Whether or not the badge is indeterminate and should just be a dot. This will ignore any children.","name":"isIndeterminate","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"BadgeProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"BadgeProps"}],"required":false,"type":{"name":"boolean"}},"children":{"defaultValue":null,"description":"The children of the component. A function may be provided to alter the children based on component state.","name":"children","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"RenderProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"RenderProps"}],"required":false,"type":{"name":"ReactNode | ((values: BadgeRenderProps & { defaultChildren: ReactNode; }) => ReactNode)"}},"className":{"defaultValue":null,"description":"The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state.","name":"className","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"StyleRenderProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"StyleRenderProps"}],"required":false,"type":{"name":"string | ((values: BadgeRenderProps & { defaultClassName: string; }) => string)"}},"style":{"defaultValue":null,"description":"The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.","name":"style","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"StyleRenderProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"StyleRenderProps"}],"required":false,"type":{"name":"CSSProperties | ((values: BadgeRenderProps & { defaultStyle: CSSProperties; }) => CSSProperties)"}}},"events":{},"accessibility":{"aria-label":{"defaultValue":null,"description":"Defines a string value that labels the current element.","name":"aria-label","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"}],"required":false,"type":{"name":"string"}},"aria-labelledby":{"defaultValue":null,"description":"Identifies the element (or elements) that labels the current element.","name":"aria-labelledby","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"}],"required":false,"type":{"name":"string"}},"aria-describedby":{"defaultValue":null,"description":"Identifies the element (or elements) that describes the object.","name":"aria-describedby","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"}],"required":false,"type":{"name":"string"}},"aria-details":{"defaultValue":null,"description":"Identifies the element (or elements) that provide a detailed, extended description for the object.","name":"aria-details","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"AriaLabelingProps"}],"required":false,"type":{"name":"string"}}},"layout":{"slot":{"defaultValue":null,"description":"A slot name for the component. Slots allow the component to receive props from a parent component.\nAn explicit `null` value indicates that the local props completely override all props received from a parent.","name":"slot","parent":{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"SlotProps"},"declarations":[{"fileName":"/packages/components/src/Badge/src/Badge.tsx","name":"SlotProps"}],"required":false,"type":{"name":"string | null"}}}}}]
1 change: 1 addition & 0 deletions apps/docs/datas/components/Button.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions apps/docs/datas/components/ButtonGroup.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"tags":{},"filePath":"/packages/components/src/buttons/src/ButtonGroup.tsx","description":"","displayName":"ButtonGroup","methods":[],"props":{"orientation":{"defaultValue":{"value":"'horizontal'"},"description":"The axis the ButtonGroup should align with.","name":"orientation","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"}],"required":false,"type":{"name":"ResponsiveProp<Orientation>"}},"isDisabled":{"defaultValue":null,"description":"Whether the Buttons in the ButtonGroup are all disabled.","name":"isDisabled","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"}],"required":false,"type":{"name":"boolean"}},"isFluid":{"defaultValue":null,"description":"Whether the Buttons in the ButtonGroup are all fluid.","name":"isFluid","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"}],"required":false,"type":{"name":"ResponsiveProp<boolean>"}},"size":{"defaultValue":{"value":"\"md\""},"description":"The size of the buttons in the ButtonGroup.","name":"size","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"}],"required":false,"type":{"name":"ResponsiveProp<ButtonSize>"}},"wrap":{"defaultValue":{"value":"true"},"description":"Whether elements are forced onto one line or can wrap onto multiple rows.","name":"wrap","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"}],"required":false,"type":{"name":"ResponsiveProp<boolean>"}},"align":{"defaultValue":{"value":"'start'"},"description":"The alignment of the buttons within the ButtonGroup.","name":"align","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"}],"required":false,"type":{"name":"ResponsiveProp<Align>"}},"style":{"defaultValue":null,"description":"","name":"style","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"HTMLAttributes"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"HTMLAttributes"}],"required":false,"type":{"name":"CSSProperties"}},"className":{"defaultValue":null,"description":"","name":"className","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"HTMLAttributes"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"id":{"defaultValue":null,"description":"","name":"id","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"HTMLAttributes"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}}},"groups":{"default":{"orientation":{"defaultValue":{"value":"'horizontal'"},"description":"The axis the ButtonGroup should align with.","name":"orientation","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"}],"required":false,"type":{"name":"ResponsiveProp<Orientation>"}},"isDisabled":{"defaultValue":null,"description":"Whether the Buttons in the ButtonGroup are all disabled.","name":"isDisabled","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"}],"required":false,"type":{"name":"boolean"}},"isFluid":{"defaultValue":null,"description":"Whether the Buttons in the ButtonGroup are all fluid.","name":"isFluid","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"}],"required":false,"type":{"name":"ResponsiveProp<boolean>"}},"size":{"defaultValue":{"value":"\"md\""},"description":"The size of the buttons in the ButtonGroup.","name":"size","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"}],"required":false,"type":{"name":"ResponsiveProp<ButtonSize>"}},"wrap":{"defaultValue":{"value":"true"},"description":"Whether elements are forced onto one line or can wrap onto multiple rows.","name":"wrap","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"}],"required":false,"type":{"name":"ResponsiveProp<boolean>"}},"align":{"defaultValue":{"value":"'start'"},"description":"The alignment of the buttons within the ButtonGroup.","name":"align","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"ButtonGroupProps"}],"required":false,"type":{"name":"ResponsiveProp<Align>"}},"style":{"defaultValue":null,"description":"","name":"style","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"HTMLAttributes"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"HTMLAttributes"}],"required":false,"type":{"name":"CSSProperties"}},"className":{"defaultValue":null,"description":"","name":"className","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"HTMLAttributes"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}},"id":{"defaultValue":null,"description":"","name":"id","parent":{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"HTMLAttributes"},"declarations":[{"fileName":"/packages/components/src/buttons/src/ButtonGroup.tsx","name":"HTMLAttributes"}],"required":false,"type":{"name":"string"}}},"events":{},"accessibility":{},"layout":{}}}]
1 change: 1 addition & 0 deletions apps/docs/datas/components/Checkbox.json

Large diffs are not rendered by default.

Loading

0 comments on commit 69c1608

Please sign in to comment.