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

Chip component #110

Open
leonid opened this issue Sep 11, 2024 · 0 comments
Open

Chip component #110

leonid opened this issue Sep 11, 2024 · 0 comments
Assignees
Milestone

Comments

@leonid
Copy link
Member

leonid commented Sep 11, 2024

A Chip component is a UI element used to display information in a compact form, often with the ability to be removed or interacted with. Here are the key features a Chip component should have:

  1. Label: Display a text label to represent the chip.
  2. Removable: Option to include a close button to remove the chip.
  3. Custom Styling: Ability to customize the appearance through CSS classes or styles.
  4. Colors and Themes: Support for different colors and themes to represent various categories or statuses.
  5. Icons: Option to include icons alongside the label.
  6. Accessibility: Ensure the component is accessible with proper ARIA attributes.
  7. Events: Emit events for user interactions such as click or remove.
  8. Sizes: Support for different sizes (e.g., small, medium, large) to fit various UI designs.
  9. Interactive: Option to make the chip clickable to perform actions or navigate.
  10. Rounded Corners: Ability to have rounded corners for a modern look.
  11. Tooltips: Option to include a tooltip for additional information.
  12. Animations: Support for animations when the chip is added or removed.
  13. Group Support: Ability to group multiple chips together for related items.
  14. Responsive Design: Adaptable to different screen sizes and orientations.
  15. Loading State: Option to show a loading state when performing asynchronous actions.

These features ensure that the Chip component is versatile, user-friendly, and accessible.

Design

https://www.figma.com/design/6nFlVmwDwvGloglQHxyElh/Syntax-UI-3.0?node-id=876-2858&m=dev

image

To be implemented

  • Vue component with basic logic
  • Styles and extension points as css properties
  • Vitepress documentation: feature description, examples and api documentation
  • Unit tests for component and its composition
  • Storybook demos and documentation
@leonid leonid self-assigned this Sep 11, 2024
@leonid leonid added this to the Alpha release milestone Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant