Added documentation concerning forms #16566
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
HDinger
reviewed
Sep 6, 2024
|
|
||
| ## Grouping and hierarchy | ||
|
|
||
| Form elements are related need to be grouped together. For this, use a form group. |
There was a problem hiding this comment.
Suggested change
| Form elements are related need to be grouped together. For this, use a form group. | |
| Form elements that are related need to be grouped together. For this, use a [form group](https://primer-lookbook.github.com/view-components/lookbook/pages/forms/groups_layouts). |
|
|
||
| Form elements are related need to be grouped together. For this, use a form group. | ||
|
|
||
| If a form is particularly long, split it into different form groups and use a `Subhead` at the start of each to give it a title. When using Subheads, we recommend implementing individual Save buttons for each section (using the <em>Secondary</em> style). If a section only contains `Toggle switch` elements, a separate Save button is not necessarily (since the Toggle sends its own server request on interaction). |
There was a problem hiding this comment.
Suggested change
| If a form is particularly long, split it into different form groups and use a `Subhead` at the start of each to give it a title. When using Subheads, we recommend implementing individual Save buttons for each section (using the <em>Secondary</em> style). If a section only contains `Toggle switch` elements, a separate Save button is not necessarily (since the Toggle sends its own server request on interaction). | |
| If a form is particularly long, split it into different form groups and use a [`Subhead`](https://primer-lookbook.github.com/view-components/lookbook/inspect/primer/beta/subhead/default) at the start of each to give it a title. When using Subheads, we recommend implementing individual Save buttons for each section (using the <em>Secondary</em> style). If a section only contains `Toggle switch` elements, a separate Save button is not necessarily (since the Toggle sends its own server request on interaction). |
cbliard
reviewed
Sep 6, 2024
Comment on lines
+34
to
+39
| - <strong>:auto</strong> => width: auto | ||
| - <strong>:small</strong> => max-width: min(256px, 100vw - 2rem) | ||
| - <strong>:medium</strong> => max-width: min(320px, 100vw - 2rem) | ||
| - <strong>:large</strong> => max-width: min(480px, 100vw - 2rem) | ||
| - <strong>:xlarge</strong> => max-width: min(640px, 100vw - 2rem) | ||
| - <strong>:xxlarge</strong> => max-width: min(960px, 100vw - 2rem) |
There was a problem hiding this comment.
A screenshot would be worth a thousand words.
There was a problem hiding this comment.
Also knowing that multiple width are available does not help making a choice. If there is a rule, here would be a good place to make it explicit.
cbliard
approved these changes
Sep 6, 2024
|
|
||
| Form elements are related need to be grouped together. For this, use a form group. | ||
|
|
||
| If a form is particularly long, split it into different form groups and use a `Subhead` at the start of each to give it a title. When using Subheads, we recommend implementing individual Save buttons for each section (using the <em>Secondary</em> style). If a section only contains `Toggle switch` elements, a separate Save button is not necessarily (since the Toggle sends its own server request on interaction). |
There was a problem hiding this comment.
Screenshots of a short form and a long form would be helpful, or links to our lookbook to such forms.
Comment on lines
+34
to
+39
| - <strong>:auto</strong> => width: auto | ||
| - <strong>:small</strong> => max-width: min(256px, 100vw - 2rem) | ||
| - <strong>:medium</strong> => max-width: min(320px, 100vw - 2rem) | ||
| - <strong>:large</strong> => max-width: min(480px, 100vw - 2rem) | ||
| - <strong>:xlarge</strong> => max-width: min(640px, 100vw - 2rem) | ||
| - <strong>:xxlarge</strong> => max-width: min(960px, 100vw - 2rem) |
There was a problem hiding this comment.
Also knowing that multiple width are available does not help making a choice. If there is a rule, here would be a good place to make it explicit.
HDinger
force-pushed
the
add-form-settings-pages-to-lookbook
branch
from
ba2287f to
83daf48
Compare
|
I forgot about this PR. I also added a forms page in another PR. A bit more technical. Once both PR are merged, we should issue a PR to merge the content of both pages into one coherent and cohesive page. The other PR is #16550. |
|
Seen with Henriette: once this PR is merged, I'll file my content in the page under a |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ticket
https://community.openproject.org/projects/openproject/work_packages/57580/activity
What are you trying to accomplish?
Add documentation to Lookbook concerning the implementation of forms and form elements in Primer.
What approach did you choose and why?
The approach was discussed and agreed upon in the frontend daily on 30 August 2024.
Merge checklist