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

Implement OnyxShortcut component #2066

Open
12 tasks
JoCa96 opened this issue Nov 11, 2024 · 0 comments
Open
12 tasks

Implement OnyxShortcut component #2066

JoCa96 opened this issue Nov 11, 2024 · 0 comments
Assignees
Labels
dev Requires technical expertise

Comments

@JoCa96
Copy link
Collaborator

JoCa96 commented Nov 11, 2024

Depends on

Why?

As a UI developer, I want to communicate to a user which keyboard shortcut they can use to trigger an action. Using this information, they can act immediately, without the need for a mouse click.

From MDN:

The <kbd> element represents a span of inline text denoting textual user input from a keyboard, voice input, or any other text entry device. By convention, the browser defaults to rendering the contents of a <kbd> element using its default monospace font, although this is not mandated by the HTML standard.

Design

Figma

Acceptance criteria

Implementation details

Reference implementations

Applicable ARIA Pattern

Definition of Done

  • The following component requirements are implemented:
    • skeleton
    • density
    • example usage added to apps/demo-app/src/views/HomeView.vue
  • covered by tests
    • functional tests (Playwright or unit test)
    • visual tests (Playwright screenshots)
  • follow-up tickets were created if necessary
  • updated version + documentation is deployed
  • Storybook can show the feature
  • Storybook code snippet of new/changed examples are checked that they are generated correctly
  • Namings are aligned with Figma

Approval

  • Storybook
  • Deployed Docs
  • approved by designer @jannick-ux
  • approved by dev
@JoCa96 JoCa96 added this to onyx Nov 11, 2024
@github-project-automation github-project-automation bot moved this to New in onyx Nov 11, 2024
@JoCa96 JoCa96 added the dev Requires technical expertise label Nov 11, 2024
@JoCa96 JoCa96 self-assigned this Nov 11, 2024
@JoCa96 JoCa96 changed the title Define OnyxKey component Implement OnyxKey component Nov 11, 2024
@JoCa96 JoCa96 changed the title Implement OnyxKey component Implement OnyxShortcut component Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev Requires technical expertise
Projects
Status: New
Development

No branches or pull requests

1 participant