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

Checkbox: support for helper text and required state #5190

Closed
7 of 21 tasks
rolfsmeds opened this issue Mar 22, 2024 · 0 comments
Closed
7 of 21 tasks

Checkbox: support for helper text and required state #5190

rolfsmeds opened this issue Mar 22, 2024 · 0 comments
Labels
acceptance criteria used for the acceptance criteria checklist DS Design System feature (e.g. component) v24.4

Comments

@rolfsmeds
Copy link
Collaborator

rolfsmeds commented Mar 22, 2024

Description

Support for helper-text in Checkbox (including individual checkboxes in a Checkbox Group), and support for required state (incl. indicator) and error message in individual Checkboxes.

Acceptance criteria

  • Helper feature ([checkbox] Add helper support web-components#3749)
    • helper slot in Checkbox
    • Automatically set aria-describedby in <input> pointing to contents of helper slot
    • WC / React API for setting helper text: helper-text/ helperText in vaadin-checkbox / Checkbox
    • Flow API from HasHelper interface
    • Flow API for providing helpers for individual items in a CheckboxGroup (API TBD)
  • Required state ([checkbox] Add required property web-components#938)
    • Flow / WC / React setRequired / required API for setting required state
    • Required indicator with required-indicator part name
    • error-message slot in Checkbox
    • Automatically set aria-describedby in <input> pointing to contents of error-message slot
    • error-message / errorMessage / setErrorMessage WC / React / Flow APIs
    • HasValidation support in Flow

UI design

image

Note: Helper and error slots could be placed in additional css grid rows below the label, with

  • padding-left: var(--lumo-space-xs) on both to align horizontally with label
  • padding-bottom: 0.4em; on both to provide appropriate spacing between them and below the last one (needed to have enough space between the helper/error of the preceding item and the label of the next item in a group)

General criteria

  • APIs reviewed
  • Design
  • Performance
  • UX/DX tests in Alpha
  • Limitations:

Security

  • Security implications have been taken into account (elaborate or link to product security requirement specification if there are implications)
@rolfsmeds rolfsmeds added acceptance criteria used for the acceptance criteria checklist DS Design System feature (e.g. component) labels Mar 22, 2024
@github-project-automation github-project-automation bot moved this to Under consideration in Roadmap Mar 22, 2024
@rolfsmeds rolfsmeds moved this from Under consideration to June 2024 in Roadmap Mar 22, 2024
@rolfsmeds rolfsmeds moved this from June 2024 to March 2024 in Roadmap Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
acceptance criteria used for the acceptance criteria checklist DS Design System feature (e.g. component) v24.4
Projects
Status: June 2024 (24.4) - Released
Development

No branches or pull requests

2 participants