deven-org / boiler

A fully customisable and tokenised design system boilerplate built by Accenture Song
https://boilerds.com/
MIT License
18 stars 7 forks source link

Button Group - Ensure Consistency between Storybook Documentation and Codebase Property Names #877

Closed angelicahoyss closed 8 months ago

angelicahoyss commented 9 months ago

Description / User story

As a developer on the team, I want to ensure consistency between the property names defined in the Storybook documentation for Button Group component So that the Button Group component codebase accurately reflects the documented property names.

This user story outlines the need to maintain consistency between the documentation and the codebase regarding component property names. Each component is checked to ensure the property names in the codebase match the corresponding names in the Storybook documentation. If the discrepancies are found, they are listed in this table on the page "ButtonGroup". Column Current Code Property Name describes how is the property currently named in the code. Column Desired Code Property Name is how the property should be named. Properties marked green don't need adjustment.

Acceptance Criteria

Code of Conduct

thrbnhrtmnn commented 8 months ago

Hey @RubirajAccenture ,

it seems to me, that the changes in the index.stories.ts were not sufficient. When I look at the Storybook documentation we now have both sizeVariant and size as props. Could you check this again?

From what I see the sizeVariant prop is missing a description in the props panel, is in the wrong order (it should be within Appearance and above "alignment) and has the wrong control (should be a select and not a input with a string). Also the size prop should be removed.

Also, when you are touching the index.stories.ts again, could you update the Intro text and remove the duplicate "Icon Button" in the last sentence?