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

docs[DST-572]: Form field guidelines #4174

Open
wants to merge 27 commits into
base: main
Choose a base branch
from
Open

Conversation

OsamaAbdellateef
Copy link
Contributor

@OsamaAbdellateef OsamaAbdellateef commented Sep 23, 2024

Description

Our form field components share many common features, such as states (disabled, error, readonly) and functionality (label, control, help text). When we revise every single page, this information would be duplicated across multiple component pages, leading to redundancy and potential inconsistencies.

As we are in the process of revising our component pages, now is the perfect time to implement this solution. Establishing a centralized page will streamline future revisions, ensuring consistency and saving time as we update and maintain our documentation.

What should be tested?

  • Should explain the anatomy of form fields (label, helptext and a “control” that depends on the field e.g. input/select/radio/…)
  • Should explain how validation works and what options there are (might be possible to just move the current “validation” page into this one and delete the “validation” page)
  • Should explain common use cases (when to use a label, when it is okay not to, when to use a placeholder, …)

Reviewers:

@marigold-ui/developer

Copy link

changeset-bot bot commented Sep 23, 2024

🦋 Changeset detected

Latest commit: 0dee034

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages
Name Type
@marigold/components Patch
@marigold/docs Patch
@marigold/storybook-config Patch
@marigold/theme-b2b Patch
@marigold/theme-core Patch
@marigold/theme-docs Patch
@marigold/system Patch
@marigold/icons Patch
@marigold/theme-preset Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Sep 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
marigold-docs ✅ Ready (Inspect) Visit Preview 19 resolved Oct 14, 2024 2:36pm
marigold-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 14, 2024 2:36pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
marigold-production ⬜️ Ignored (Inspect) Visit Preview 💬 Add feedback Oct 14, 2024 2:36pm

@github-actions github-actions bot added the type:docs Improvements or additions to documentation label Sep 23, 2024
Copy link
Contributor

github-actions bot commented Sep 23, 2024

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements
99.23% (+0.02% 🔼)
7871/7932
🟢 Branches
89.74% (+0.35% 🔼)
350/390
🟢 Functions
98.44% (-0.05% 🔻)
126/128
🟢 Lines
99.23% (+0.02% 🔼)
7871/7932
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / Dialog.tsx
100%
75% (-12.5% 🔻)
66.67% (-19.05% 🔻)
100%
🟢
... / Input.tsx
98.72% (-1.28% 🔻)
80% (-20% 🔻)
100%
98.72% (-1.28% 🔻)
🟢
... / Text.tsx
100%
14.29% (-14.29% 🔻)
100% 100%

Test suite run success

570 tests passing in 78 suites.

Report generated by 🧪jest coverage report action from 0dee034

@sarahgm
Copy link
Member

sarahgm commented Oct 7, 2024

@OsamaAbdellateef can you edit the title of the PR so its containing the issue and the type of change?
Also this review can be done by designer and katharina right?

@sarahgm
Copy link
Member

sarahgm commented Oct 7, 2024

@OsamaAbdellateef also changeset is missing

@sarahgm
Copy link
Member

sarahgm commented Oct 14, 2024

I reviewed. Someone else maybe should also: @sebald @marcelkoehler @tirado-rx @KadaStrophe ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs Improvements or additions to documentation type:feature New feature or component
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants