@maggioli-design-system/mds-modal
v5.2.1
Published
mds-modal is a web-component from Magma Design System, built with StencilJS, TypeScript, Storybook. It's based on the web-component standard and it's designed to be agnostic from the JavaScript framework you are using.
Downloads
1,051
Readme
mds-modal
This is a web-component from Maggioli Design System Magma, built with StencilJS, TypeScript, Storybook. It's based on the web-component standard and it's designed to be agnostic from the JavaScript framework you are using.
Properties
| Property | Attribute | Description | Type | Default |
| ----------- | ----------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| animating
| animating
| Specifies if the component is animating itself or not | "intro" \| "none" \| "outro" \| undefined
| 'none'
|
| opened
| opened
| Specifies if the modal is opened or not | boolean
| false
|
| position
| position
| Specifies the animation position of the modal window | "bottom" \| "bottom-left" \| "bottom-right" \| "center" \| "left" \| "right" \| "top" \| "top-left" \| "top-right" \| undefined
| 'center'
|
Events
| Event | Description | Type |
| --------------- | --------------------------------------------------------------------------------------------------------------- | ------------------- |
| mdsModalClose
| Emits when a modal is closed | CustomEvent<void>
|
| mdsModalHide
| Emits when a modal is totally invisible, can be useful to detach the component when it's hidden and gain memory | CustomEvent<void>
|
Slots
| Slot | Description |
| ----------- | -------------------------------------------------------------------------------------------------------------------------- |
| "bottom"
| Contents that will be placed on bottom of the window. Add text string
, HTML elements
or components
to this slot. |
| "default"
| Contents that will be placed in the center of the window. Add text string
, HTML elements
or components
to this slot. |
| "top"
| Contents that will be placed on top of the window. Add text string
, HTML elements
or components
to this slot. |
| "window"
| Use directly a window component if you need it. Add text string
, HTML elements
or components
to this slot. |
Shadow Parts
| Part | Description |
| ---------- | ----------- |
| "window"
| |
CSS Custom Properties
| Name | Description |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| --mds-modal-close-icon-color
| Set the color of the close icon button to the top left. |
| --mds-modal-overlay-color
| Set the overlay color of the background when the component is opened, this property can be inherited from globals.css
in styles^8.0.0
. |
| --mds-modal-overlay-opacity
| Set the overlay color opacity of the background when the component is opened, this property can be inherited from globals.css
in styles^8.0.0
. |
| --mds-modal-window-background
| Set the background color of the window |
| --mds-modal-window-distance
| Set the distance between the modal window and the screen bounds |
| --mds-modal-window-overflow
| Set the overflow of the window |
| --mds-modal-window-radius
| Set the border radius of the window |
| --mds-modal-window-shadow
| Set the box shadow of the window |
| --mds-modal-z-index
| Set the z-index of the window when the component is opened |
Dependencies
Used by
Depends on
Graph
graph TD;
mds-modal --> mds-button
mds-button --> mds-spinner
mds-button --> mds-icon
mds-button --> mds-text
mds-header --> mds-modal
style mds-modal fill:#f9f,stroke:#333,stroke-width:4px
Built with love @ Gruppo Maggioli from R&D Department