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

Write a document that describes API patterns we use in the design system #156

Open
nlopin opened this issue Jul 15, 2021 · 1 comment
Open
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@nlopin
Copy link
Contributor

nlopin commented Jul 15, 2021

The idea is to have some guidelines :

  • what is considered a variant
  • where we attach refs
  • where do we spread props
  • how we deal with aria attributes
  • etc

This issue will be a collection of patterns that we then process and wrap into a document.

@lukahartwig @snapsnapturtle @duranmla please, bring your ideas

@nlopin nlopin added the documentation Improvements or additions to documentation label Jul 15, 2021
@nlopin
Copy link
Contributor Author

nlopin commented Jul 15, 2021

Ref rule

  • ref should be attached to the most obvious component. For example, for Input to <input>, for Checkbox to <input type="checkbox">
  • if there is more than one "obvious" or "expected" place to add ref, there should be no ref prop, but custom ref prop for each place. For example, for Datepicker that selects a time period contains should have two refs fromRef and toRef

@nlopin nlopin self-assigned this Aug 12, 2021
@nlopin nlopin added the conversation needed Issues that may need to go to a broader conversation label Aug 16, 2021
@snapsnapturtle snapsnapturtle removed the conversation needed Issues that may need to go to a broader conversation label Aug 26, 2021
@martimalek martimalek mentioned this issue Oct 25, 2023
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

No branches or pull requests

2 participants