<multi-page-dialog>
This webcomponent follows the open-wc recommendation.
Installation
npm i multi-page-dialog
Usage
<script type="module">
import 'multi-page-dialog';
</script>
<multi-page-dialog></multi-page-dialog>
Linting and formatting
To scan the project for linting and formatting errors, run
npm run lint
To automatically fix linting and formatting errors, run
npm run format
Testing with Web Test Runner
To execute a single test run:
npm run test
To run the tests in interactive watch mode run:
npm run test:watch
Demoing with Storybook
To run a local instance of Storybook for your component, run
npm run storybook
To build a production version of Storybook, run
npm run storybook:build
Tooling configs
For most of the tools, the configuration is in the package.json
to reduce the amount of files in your project.
If you customize the configuration a lot, you can consider moving them to individual files.
web-dev-server
Local Demo with npm start
To run a local development server that serves the basic demo located in demo/index.html
multi-page-dialog.ts
:
MultiPageDialog
class: Superclass
Name | Module | Package |
---|---|---|
LitElement |
lit |
Fields
Name | Privacy | Type | Default | Description | Inherited From |
---|---|---|---|---|---|
open |
boolean |
false |
Whether dialog is open | ||
stacked |
boolean |
false |
Whether dialog actions are stacked | ||
heading |
string |
'' |
Dialogs header content | ||
dialog |
Dialog |
Events
Name | Type | Description | Inherited From |
---|---|---|---|
turn-page |
Navigate to the next, previous or user defined page |
CSS Properties
Name | Default | Description |
---|---|---|
--mdc-theme-error |
Color of the cancel button |
Slots
Name | Description |
---|---|
default |
Content of the dialog |
secondaryAction |
Overwrites default `secondaryAction` buttons |
primaryAction |
Overwrites default `primaryAction` buttons |
Private API
Fields
Name | Privacy | Type | Default | Description | Inherited From |
---|---|---|---|---|---|
prevPage |
private | MultiPageDialog | null |
|||
nextPage |
private | MultiPageDialog | null |
|||
allDescendants |
private | Element[] |
Methods
Name | Privacy | Description | Parameters | Return | Inherited From |
---|---|---|---|---|---|
invalidDescendant |
private | boolean |
|||
turnPage |
private | increment: number |
Promise<void> |
||
onTurnPage |
private | evt: CustomEvent<TurnPageDetail> |
void |
||
onClosed |
private | ae: CustomEvent<{ action: string } | null> |
Promise<void> |
Exports
Kind | Name | Declaration | Module | Package |
---|---|---|---|---|
js |
MultiPageDialog |
MultiPageDialog | multi-page-dialog.ts |
© 2023 THE AUTHORS