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

CharacterCount - Design System #590

Open
jgonza16 opened this issue Jan 26, 2024 · 0 comments
Open

CharacterCount - Design System #590

jgonza16 opened this issue Jan 26, 2024 · 0 comments
Milestone

Comments

@jgonza16
Copy link
Collaborator

jgonza16 commented Jan 26, 2024

CharacterCount - Design System

1 - Prerequisites

  • Host element will have the .dcx-character-count class name
  • Host element will have conditional classes for error state .dcx-character-count--error class name
  • Host element will have conditional classes for filled state .dcx-character-count--filled class name

2 - Overview

2.1 - Possible states

Name Description
Default Instance without specific properties defined
Disabled Instance with native input disabled
Filled Instance with value
Focus Instance while receiving focus on native input
Error Instance with validation errors

2.2 - Variants

Name Description
Default Default look & feel
Floating Same as FormSelect we can have a floating label effect

2.3 - Structure

Element Description  Token Name
CharacterCountBox The native input itself  formcontrol
Label The label element, acts as placeholder too  formcontrol_label
Error The error message  formcontrol_error
Hint The hint message  formcontrol_hint

When developing take a close look to the FormSelect component. It is a form element as well, the tokens and styling approach should be similar.

2.4 - Tokens definition

Considerations:

  • ❗ Take a close look to the FormSelect component. It is a form element as well, the tokens and styling approach should be similar.
  • Add the tokens to src/design-system/tokens.json
  • Define all styles in src/design-system/forminput.css
  • Add import to the new CSS file in src/design-system/index.css

Possible tokens:

  • color-text-formcontrol
  • color-text-formcontrol-filled
  • color-text-formcontrol-error
  • color-text-formcontrol-floating-filled
  • color-text-formcontrol_label
  • color-text-formcontrol_label-filled
  • color-text-formcontrol_label-error
  • color-text-formcontrol_label-floating-error
  • etc.

Follow the naming pattern

3 - Storybook

Create the pages for:

  • Playground
  • Default
  • AccessibleTheme
  • DarkTheme
  • MaterialTheme

On each MDX page make examples for each possible variant

4 - Initial setup

Please follow these steps to create your branch:

git checkout release/1.1.0
git pull
git checkout -b 'feature/forminput-design-system'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants