digitransit-ui/digitransit-component/packages/digitransit-component-dialog-modal/README.md

1.5 KiB

@digitransit-component/digitransit-component-dialog-modal

DialogModal

General component description in JSDoc format. Markdown is supported.

Parameters

  • $0 Object
    • $0.headerText
    • $0.dialogContent
    • $0.handleClose
    • $0.primaryButtonText
    • $0.primaryButtonOnClick
    • $0.secondaryButtonText
    • $0.secondaryButtonOnClick
    • $0.lang
    • $0.href
    • $0.appElement
    • $0.isModalOpen
    • $0.modalAriaLabel
    • $0.color
    • $0.hoverColor

Examples

<DialogModal />

This module is part of the Digitransit-ui project. It is maintained in the HSLdevcom/digitransit-ui repository, where you can create PRs and issues.

Installation

Install this module individually:

$ npm install @digitransit-component/digitransit-component-dialog-modal

Or install the digitransit-component module that includes it as a class:

$ npm install @digitransit-component/digitransit-component