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

Components: better "rail" vs "track" docs in <RangeControl /> #34292

Closed
3 tasks
Tracked by #34304
ciampo opened this issue Aug 25, 2021 · 3 comments
Closed
3 tasks
Tracked by #34304

Components: better "rail" vs "track" docs in <RangeControl /> #34292

ciampo opened this issue Aug 25, 2021 · 3 comments
Labels
[Feature] Component System WordPress component system [Package] Components /packages/components [Type] Developer Documentation Documentation for developers

Comments

@ciampo
Copy link
Contributor

ciampo commented Aug 25, 2021

Why

The RangeControl component's README has an "Anatomy" section which refers to the different elements that the component is made of.

This section is missing an entry about the "Rail" part.

What

Update the RangeControl README to add info about the "Rail" element:

  • The rail represents the whole surface of the slider (from the min to the max value selectable by the user) (the part in blue in the screenshot)
  • The track represents the part of the rail from the minimum value possible to the currently selected value (the part in red in the screenshot)
range-control-track-rail.mp4

A/C

  • Add a "Rail" entry to the "Anatomy" section in the RangeControl component's README
  • Update the "Track" entry
  • Update the schematics
@ciampo ciampo added [Feature] Component System WordPress component system [Package] Components /packages/components [Type] Developer Documentation Documentation for developers labels Aug 25, 2021
@ciampo ciampo changed the title Components: add "rail" to the Anatomy section of <RangeControl /> docs Components: better docs for "Rail" vs "Track" in <RangeControl /> docs Aug 25, 2021
@ciampo ciampo changed the title Components: better docs for "Rail" vs "Track" in <RangeControl /> docs Components: better "rail" vs "track" docs in <RangeControl /> Aug 25, 2021
@kkoppenhaver
Copy link
Contributor

@ciampo I've put together a PR for this over at #44057. But I see the third item in your checklist is Update the schematics and I'm not sure if there's more to be done on this one or if the PR is ok as-is.

@ryanwelcher
Copy link
Contributor

@ciampo @kkoppenhaver just wanted to nudge this to see if we can bring it across the finish line.

@ciampo
Copy link
Contributor Author

ciampo commented Apr 11, 2023

Closing this issue as it was fixed by #44057

@ciampo ciampo closed this as completed Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Component System WordPress component system [Package] Components /packages/components [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

3 participants