Skip to content
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

Clean up readme files #6703

Merged
merged 2 commits into from
Jul 21, 2022
Merged

Clean up readme files #6703

merged 2 commits into from
Jul 21, 2022

Conversation

alex-page
Copy link
Member

When automating bringing across example titles a bunch of changes were noticed. This cleans them up for automation.

Comment on lines -223 to -230
When the `error` prop has a boolean value of `true`, the select component indicates to merchants that their input is invalid without rendering an error message directly below it. It anticipates that an inline error component exists separately within the form.

To render an invalid select and its validation error separately:

- Set a unique identifier to the select component `id` prop
- Set a boolean to the select component `error` prop
- Use an [inline error component](https://polaris.shopify.com/components/inline-error) to describe the invalid select input and set its `fieldID` prop to the same unique identifier used for the text field `id`

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't used on the new site and is quite detailed information. I am going to remove for now.

@alex-page alex-page merged commit e58092a into main Jul 21, 2022
@alex-page alex-page deleted the cleanup-readme-v2 branch July 21, 2022 02:03
@github-actions
Copy link
Contributor

github-actions bot commented Jul 21, 2022

size-limit report 📦

Path Size
polaris-react-cjs 198.16 KB (0%)
polaris-react-esm 133.08 KB (0%)
polaris-react-esnext 188.22 KB (0%)
polaris-react-css 41.74 KB (0%)

@alex-page
Copy link
Member Author

cc @martenbjork for visibility, have to merge a couple of these to stay unblocked. Let me know if you spot any issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant