mirror of
https://github.com/HSLdevcom/digitransit-ui
synced 2025-07-08 04:00:38 +02:00
57 lines
1.5 KiB
Markdown
57 lines
1.5 KiB
Markdown
# @digitransit-component/digitransit-component-dialog-modal
|
|
|
|
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
|
|
|
|
## DialogModal
|
|
|
|
General component description in JSDoc format. Markdown is _supported_.
|
|
|
|
### Parameters
|
|
|
|
- `$0` **[Object][1]**
|
|
- `$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
|
|
|
|
```javascript
|
|
<DialogModal />
|
|
```
|
|
|
|
[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
|
|
|
|
<!-- This file is automatically generated. Please don't edit it directly:
|
|
if you find an error, edit the source file (likely index.js), and re-run
|
|
./scripts/generate-readmes in the digitransit-component project. -->
|
|
|
|
---
|
|
|
|
This module is part of the Digitransit-ui project. It is maintained in the
|
|
[HSLdevcom/digitransit-ui](https://github.com/HSLdevcom/digitransit-ui) repository, where you can create
|
|
PRs and issues.
|
|
|
|
### Installation
|
|
|
|
Install this module individually:
|
|
|
|
```sh
|
|
$ npm install @digitransit-component/digitransit-component-dialog-modal
|
|
```
|
|
|
|
Or install the digitransit-component module that includes it as a class:
|
|
|
|
```sh
|
|
$ npm install @digitransit-component/digitransit-component
|
|
```
|