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 reveal mode for OnyxHeadline #2470

Open
15 tasks
larsrickert opened this issue Jan 9, 2025 · 0 comments
Open
15 tasks

Implement reveal mode for OnyxHeadline #2470

larsrickert opened this issue Jan 9, 2025 · 0 comments
Assignees
Labels
0-refinement All issues that can or need to be estimated in our next refinement dev Requires technical expertise
Milestone

Comments

@larsrickert
Copy link
Collaborator

Why?

The existing OnyxHeadline component should support a reveal mode that can be used to reveal content (similar to the accordion).

Open questions / TODOs

  • should the revealed content be part of the headline (e.g. a slot) or be placed by the project?

Depends on

Design

Figma

Acceptance criteria

  • an optional reveal mode is supported by the OnyxHeadline
  • the API is the same as for the OnyxAccordion / OnyxAccordionItem
  • keyboard is supported

Implementation details

<-- Add technical details / implementation proposals if necessary, e.g.:

  • API proposal
  • relevant web APIs
  • learnings from other implementations
  • code snippets
    -->

Reference implementations

OnyxAccordion

Applicable ARIA Pattern

Accordion pattern

Definition of Done

  • The following component requirements are implemented:

    • skeleton
    • density
    • example usage added to apps/demo-app/src/views/HomeView.vue
  • Should be covered by tests:

    • functional tests (Playwright or unit test)
    • visual tests (Playwright screenshots)
  • Make sure, that

    • 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
Documentation

  • Checked and approved by
    • designer
    • dev
@larsrickert larsrickert added the dev Requires technical expertise label Jan 9, 2025
@larsrickert larsrickert added this to onyx Jan 9, 2025
@github-project-automation github-project-automation bot moved this to New in onyx Jan 9, 2025
@larsrickert larsrickert moved this from New to Backlog in onyx Jan 9, 2025
@larsrickert larsrickert added the 0-refinement All issues that can or need to be estimated in our next refinement label Jan 9, 2025
@larsrickert larsrickert self-assigned this Jan 9, 2025
@larsrickert larsrickert mentioned this issue Jan 9, 2025
19 tasks
@mj-hof mj-hof added this to the Headlines milestone Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0-refinement All issues that can or need to be estimated in our next refinement dev Requires technical expertise
Projects
Status: Backlog
Development

No branches or pull requests

2 participants