-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[ButtonGroup] Update ButtonGroup documentation examples
#9099
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
kyledurand
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. I added a little mp4 video so Jordan can see how the example works. Looks good to me though
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From what I can see from the video attached to PR, this looks good to me 👍
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @shopify/stylelint-polaris@12.0.0 ### Major Changes - [#9097](#9097) [`a64e38948`](a64e389) Thanks [@samrose3](https://github.com/samrose3)! - Re-enabled layout warnings for coverage rules ## @shopify/polaris@10.49.0 ### Minor Changes - [#9051](#9051) [`722b818b4`](722b818) Thanks [@camielvs](https://github.com/camielvs)! - Added `integer` option for the `type` prop of TextField ### Patch Changes - [#9108](#9108) [`6fd00eb7c`](6fd00eb) Thanks [@laurkim](https://github.com/laurkim)! - Refactored `Box` border radius properties to fix issues with cascading styles ## @shopify/polaris-cli@0.1.35 ### Patch Changes - Updated dependencies \[]: - @shopify/polaris-migrator@0.18.1 ## @shopify/polaris-codemods@0.1.1 ### Patch Changes - Updated dependencies \[[`a64e38948`](a64e389)]: - @shopify/stylelint-polaris@12.0.0 ## @shopify/polaris-migrator@0.18.1 ### Patch Changes - Updated dependencies \[[`a64e38948`](a64e389)]: - @shopify/stylelint-polaris@12.0.0 ## polaris.shopify.com@0.52.0 ### Minor Changes - [#9087](#9087) [`efdcb10db`](efdcb10) Thanks [@lgriffee](https://github.com/lgriffee)! - Updated instances of "spacing" on `/design/space` to "space". - [#9088](#9088) [`13e9b1e47`](13e9b1e) Thanks [@lgriffee](https://github.com/lgriffee)! - Matched v11 migration docs to migrations folder - [#9099](#9099) [`227490514`](2274905) Thanks [@chazdean](https://github.com/chazdean)! - Updated `ButtonGroup` examples to include `Pressed with segmented buttons` ### Patch Changes - [#9062](#9062) [`32dae8638`](32dae86) Thanks [@jesstelford](https://github.com/jesstelford)! - Merge /patterns-legacy index page into /patterns to ease discovery (includes a redirect so old links continue to work) - Updated dependencies \[[`722b818b4`](722b818), [`6fd00eb7c`](6fd00eb)]: - @shopify/polaris@10.49.0 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
<!-- ☝️How to write a good PR title: - Prefix it with [ComponentName] (if applicable), for example: [Button] - Start with a verb, for example: Add, Delete, Improve, Fix… - Give as much context as necessary and as little as possible - Prefix it with [WIP] while it’s a work in progress --> ### WHY are these changes introduced? [ButtonGroup](https://polaris.shopify.com/components/actions/button-group) documentation was missing an example of a specific use-case that users hoping to use the `ButtonGroup` component may find helpful <!-- Context about the problem that’s being addressed. --> ### WHAT is this pull request doing? Updates `ButtonGroup` documentation to include a new button group example `Pressed With Segmented Buttons` along with updating previous example descriptions <img width="600" alt="Screenshot" src="https://user-images.githubusercontent.com/59836805/234672879-d2cf19f0-c540-4495-b013-7faae917a257.png"> https://user-images.githubusercontent.com/6844391/234679674-daf1fbdd-02d8-4d05-8c55-02dd2f00270e.mp4 <!-- Summary of the changes committed. Before / after screenshots are appreciated for UI changes. Make sure to include alt text that describes the screenshot. If you include an animated gif showing your change, wrapping it in a details tag is recommended. Gifs usually autoplay, which can cause accessibility issues for people reviewing your PR: <details> <summary>Summary of your gif(s)</summary> <img src="..." alt="Description of what the gif shows"> </details> --> <!-- ℹ️ Delete the following for small / trivial changes -->
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @shopify/stylelint-polaris@12.0.0 ### Major Changes - [Shopify#9097](Shopify#9097) [`a64e38948`](Shopify@a64e389) Thanks [@samrose3](https://github.com/samrose3)! - Re-enabled layout warnings for coverage rules ## @shopify/polaris@10.49.0 ### Minor Changes - [Shopify#9051](Shopify#9051) [`722b818b4`](Shopify@722b818) Thanks [@camielvs](https://github.com/camielvs)! - Added `integer` option for the `type` prop of TextField ### Patch Changes - [Shopify#9108](Shopify#9108) [`6fd00eb7c`](Shopify@6fd00eb) Thanks [@laurkim](https://github.com/laurkim)! - Refactored `Box` border radius properties to fix issues with cascading styles ## @shopify/polaris-cli@0.1.35 ### Patch Changes - Updated dependencies \[]: - @shopify/polaris-migrator@0.18.1 ## @shopify/polaris-codemods@0.1.1 ### Patch Changes - Updated dependencies \[[`a64e38948`](Shopify@a64e389)]: - @shopify/stylelint-polaris@12.0.0 ## @shopify/polaris-migrator@0.18.1 ### Patch Changes - Updated dependencies \[[`a64e38948`](Shopify@a64e389)]: - @shopify/stylelint-polaris@12.0.0 ## polaris.shopify.com@0.52.0 ### Minor Changes - [Shopify#9087](Shopify#9087) [`efdcb10db`](Shopify@efdcb10) Thanks [@lgriffee](https://github.com/lgriffee)! - Updated instances of "spacing" on `/design/space` to "space". - [Shopify#9088](Shopify#9088) [`13e9b1e47`](Shopify@13e9b1e) Thanks [@lgriffee](https://github.com/lgriffee)! - Matched v11 migration docs to migrations folder - [Shopify#9099](Shopify#9099) [`227490514`](Shopify@2274905) Thanks [@chazdean](https://github.com/chazdean)! - Updated `ButtonGroup` examples to include `Pressed with segmented buttons` ### Patch Changes - [Shopify#9062](Shopify#9062) [`32dae8638`](Shopify@32dae86) Thanks [@jesstelford](https://github.com/jesstelford)! - Merge /patterns-legacy index page into /patterns to ease discovery (includes a redirect so old links continue to work) - Updated dependencies \[[`722b818b4`](Shopify@722b818), [`6fd00eb7c`](Shopify@6fd00eb)]: - @shopify/polaris@10.49.0 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
<!-- ☝️How to write a good PR title: - Prefix it with [ComponentName] (if applicable), for example: [Button] - Start with a verb, for example: Add, Delete, Improve, Fix… - Give as much context as necessary and as little as possible - Prefix it with [WIP] while it’s a work in progress --> ### WHY are these changes introduced? [ButtonGroup](https://polaris.shopify.com/components/actions/button-group) documentation was missing an example of a specific use-case that users hoping to use the `ButtonGroup` component may find helpful <!-- Context about the problem that’s being addressed. --> ### WHAT is this pull request doing? Updates `ButtonGroup` documentation to include a new button group example `Pressed With Segmented Buttons` along with updating previous example descriptions <img width="600" alt="Screenshot" src="https://user-images.githubusercontent.com/59836805/234672879-d2cf19f0-c540-4495-b013-7faae917a257.png"> https://user-images.githubusercontent.com/6844391/234679674-daf1fbdd-02d8-4d05-8c55-02dd2f00270e.mp4 <!-- Summary of the changes committed. Before / after screenshots are appreciated for UI changes. Make sure to include alt text that describes the screenshot. If you include an animated gif showing your change, wrapping it in a details tag is recommended. Gifs usually autoplay, which can cause accessibility issues for people reviewing your PR: <details> <summary>Summary of your gif(s)</summary> <img src="..." alt="Description of what the gif shows"> </details> --> <!-- ℹ️ Delete the following for small / trivial changes -->
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @shopify/stylelint-polaris@12.0.0 ### Major Changes - [Shopify#9097](Shopify#9097) [`a64e38948`](Shopify@d289bb9) Thanks [@samrose3](https://github.com/samrose3)! - Re-enabled layout warnings for coverage rules ## @shopify/polaris@10.49.0 ### Minor Changes - [Shopify#9051](Shopify#9051) [`722b818b4`](Shopify@a7b28bf) Thanks [@camielvs](https://github.com/camielvs)! - Added `integer` option for the `type` prop of TextField ### Patch Changes - [Shopify#9108](Shopify#9108) [`6fd00eb7c`](Shopify@6c91a77) Thanks [@laurkim](https://github.com/laurkim)! - Refactored `Box` border radius properties to fix issues with cascading styles ## @shopify/polaris-cli@0.1.35 ### Patch Changes - Updated dependencies \[]: - @shopify/polaris-migrator@0.18.1 ## @shopify/polaris-codemods@0.1.1 ### Patch Changes - Updated dependencies \[[`a64e38948`](Shopify@d289bb9)]: - @shopify/stylelint-polaris@12.0.0 ## @shopify/polaris-migrator@0.18.1 ### Patch Changes - Updated dependencies \[[`a64e38948`](Shopify@d289bb9)]: - @shopify/stylelint-polaris@12.0.0 ## polaris.shopify.com@0.52.0 ### Minor Changes - [Shopify#9087](Shopify#9087) [`efdcb10db`](Shopify@1a72f1e) Thanks [@lgriffee](https://github.com/lgriffee)! - Updated instances of "spacing" on `/design/space` to "space". - [Shopify#9088](Shopify#9088) [`13e9b1e47`](Shopify@33a15a2) Thanks [@lgriffee](https://github.com/lgriffee)! - Matched v11 migration docs to migrations folder - [Shopify#9099](Shopify#9099) [`227490514`](Shopify@d525b82) Thanks [@chazdean](https://github.com/chazdean)! - Updated `ButtonGroup` examples to include `Pressed with segmented buttons` ### Patch Changes - [Shopify#9062](Shopify#9062) [`32dae8638`](Shopify@3c7b4fc) Thanks [@jesstelford](https://github.com/jesstelford)! - Merge /patterns-legacy index page into /patterns to ease discovery (includes a redirect so old links continue to work) - Updated dependencies \[[`722b818b4`](Shopify@a7b28bf), [`6fd00eb7c`](Shopify@6c91a77)]: - @shopify/polaris@10.49.0 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
WHY are these changes introduced?
ButtonGroup documentation was missing an example of a specific use-case that users hoping to use the
ButtonGroupcomponent may find helpfulWHAT is this pull request doing?
Updates
ButtonGroupdocumentation to include a new button group examplePressed With Segmented Buttonsalong with updating previous example descriptionsbutton.group.mp4