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 OnyxAlertDialog #2306

Open
17 tasks
larsrickert opened this issue Dec 11, 2024 · 0 comments
Open
17 tasks

Implement OnyxAlertDialog #2306

larsrickert opened this issue Dec 11, 2024 · 0 comments
Assignees
Labels
dev Requires technical expertise

Comments

@larsrickert
Copy link
Collaborator

larsrickert commented Dec 11, 2024

Why?

We want to offer a pre-build alert dialog component that can be used to quickly implement common alert dialogs (e.g. delete or confirm dialogs).

Internally, the component uses our existing generic OnyxDialog component.

Open questions / TODOs

No response

Depends on

No response

Design

Figma design

Acceptance criteria

  • the component shows a required headline
  • a close "x" button is shown in the top right corner to close the dialog, should use the OnyxSystemButton
  • custom content can be passed via a slot for the main dialog content
  • a slot for custom right-aligned buttons can be used
  • an optional icon can be displayed. The icon and the color can be changed
  • check if we want to have a dedicated group in the Storybook sidebar

Implementation details

  • the close "x" button might be considered to be implemented inside the OnyxDialog for all modals
  • for the internally used OnyxDialog, both modal and alert property are always set
export type OnyxAlertDialogProps = Omit<OnyxDialogProps, "modal" | "alert">;

Reference implementations

No response

Applicable ARIA Pattern

Alert dialog pattern

Definition of Done

  • The following component requirements are implemented:

    • 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 Dec 11, 2024
@larsrickert larsrickert added this to onyx Dec 11, 2024
@github-project-automation github-project-automation bot moved this to New in onyx Dec 11, 2024
@larsrickert larsrickert self-assigned this Dec 11, 2024
@larsrickert larsrickert added the 0-refinement All issues that can or need to be estimated in our next refinement label Dec 11, 2024
@larsrickert larsrickert moved this from New to Backlog in onyx Dec 11, 2024
@mj-hof mj-hof added this to the Modal & dialog milestone Dec 11, 2024
@mj-hof mj-hof moved this from Backlog to Ready in onyx Dec 11, 2024
@mj-hof mj-hof removed the 0-refinement All issues that can or need to be estimated in our next refinement label Dec 11, 2024
@mj-hof mj-hof assigned larsrickert and unassigned larsrickert Dec 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: Ready
Development

No branches or pull requests

2 participants