Page MenuHomePhabricator

Port Dialog Component to WiKit
Closed, ResolvedPublic8 Estimated Story Points

Description

To make sure the components we create with Design System specifications are reusable for other hikes, we need to ensure that they are included in the WiKit Components Library. This task aims to move the Dialog component created in the Mismatch finder app to WiKit, and ensure that the wikit-Dialog component is the single source of truth.

AC

  • The Dialog component is included and documented in WiKit: i.e. each prop and event are documented and controllable in storybook.
  • The Dialog component's unit tests are moved to Wikit and adapted to pass
  • A WiKit release is published with the Dialog component
  • The Dialog Component is removed from Mismatch Finder
  • The WiKit Dialog is used in the Mismatch Finder app instead

Event Timeline

Notes from task breakdown

Copy-Paste: T295874: Copy Dialog Component Code to WiKit

Storybook: T295875: Add Storybook Documentation for Dialog Component

  • Structure: the Dialog component has its own section is Storybook, called "Dialog". The section contains a "Complex" section displaying the "Complex" dialog.
  • Documentation: each prop and event are documented and controllable in storybook.
  • Behavior: users should be able to interact with the dialog. A button with the text "Open dialog" should allow users to trigger the display of the Dialog in case they closed it. (The component should be displayed by default)
  • Controls: users should be able to modify the copy of the title, the body and the button labels of the dialog. A secondary button/action might be optional.
  • Copy: see Figma (to be editable by the user)

Testing: T295876: Add browser tests to WiKit Dialog component

  • Add suggested browser tests to wikit in order to test dialog behavior

Release: T295877: WiKit pre-release with Dialog component

  • Update Changelog: "New Complex Dialog Component" (in Added section)
  • A new WiKit pre-release is published with the Dialog component
  • The Dialog Component is replaced by the WiKit Dialog in Mismatch Finder
Sarai-WMDE claimed this task.

Please note that the 3rd point "A WiKit release is published with the Dialog component" actually refers to a "pre-release" (T295877). The latest WiKit release will be handled separately.