@3mo/dialog
Version:
A dialog component based on Material Web Components.
642 lines • 13.7 kB
JSON
{
"version": "experimental",
"tags": [
{
"name": "mo-dialog",
"path": ".\\packages\\Dialog\\Dialog.ts",
"attributes": [
{
"name": "size",
"type": "DialogSize",
"default": "\"small\""
},
{
"name": "blocking",
"type": "boolean",
"default": "false"
},
{
"name": "primaryButtonText",
"type": "string | undefined"
},
{
"name": "secondaryButtonText",
"type": "string | undefined"
},
{
"name": "open",
"type": "boolean",
"default": "false"
},
{
"name": "primaryOnEnter",
"type": "boolean",
"default": "false"
},
{
"name": "poppable",
"type": "boolean",
"default": "false"
},
{
"name": "boundToWindow",
"type": "boolean",
"default": "false"
},
{
"name": "manualClose",
"type": "boolean",
"default": "false"
},
{
"name": "heading",
"type": "string",
"default": "\"\""
}
],
"properties": [
{
"name": "executingActionAdaptersByComponent",
"type": "Map<Constructor<HTMLElement>, (actionElement: HTMLElement, isExecuting: boolean) => void>",
"default": "\"new Map<Constructor<HTMLElement>, (actionElement: HTMLElement, isExecuting: boolean) => void>()\""
},
{
"name": "size",
"attribute": "size",
"type": "DialogSize",
"default": "\"small\""
},
{
"name": "blocking",
"attribute": "blocking",
"type": "boolean",
"default": "false"
},
{
"name": "primaryButtonText",
"attribute": "primaryButtonText",
"type": "string | undefined"
},
{
"name": "secondaryButtonText",
"attribute": "secondaryButtonText",
"type": "string | undefined"
},
{
"name": "open",
"attribute": "open",
"type": "boolean",
"default": "false"
},
{
"name": "topLayerElement",
"type": "ApplicationTopLayer"
},
{
"name": "primaryActionElement",
"type": "HTMLElement"
},
{
"name": "secondaryActionElement",
"type": "HTMLElement"
},
{
"name": "cancellationActionElement",
"type": "HTMLElement"
},
{
"name": "handleAction",
"type": "(key: DialogActionKey) => void | Promise<void>"
},
{
"name": "executingAction",
"type": "DialogActionKey | undefined"
},
{
"name": "preventCancellationOnEscape",
"type": "boolean"
},
{
"name": "primaryOnEnter",
"attribute": "primaryOnEnter",
"type": "boolean",
"default": "false"
},
{
"name": "poppable",
"attribute": "poppable",
"type": "boolean",
"default": "false"
},
{
"name": "boundToWindow",
"attribute": "boundToWindow",
"type": "boolean",
"default": "false"
},
{
"name": "requestPopup",
"type": "EventDispatcher<void>"
},
{
"name": "manualClose",
"attribute": "manualClose",
"type": "boolean",
"default": "false"
},
{
"name": "errorHandler",
"type": "DialogErrorHandler | undefined"
},
{
"name": "pageHeadingChange",
"description": "The event must be \"composed\", \"bubbles\" and \"cancellable\"",
"type": "EventDispatcher<string>"
},
{
"name": "heading",
"attribute": "heading",
"type": "string",
"default": "\"\""
}
],
"events": [
{
"name": "pageHeadingChange",
"description": "Dispatched when the dialog heading changes",
"type": "CustomEvent<string>"
},
{
"name": "requestPopup",
"description": "Dispatched when the dialog is requested to be popped up",
"type": "CustomEvent<void>"
},
{
"name": "scroll",
"type": "CustomEvent"
}
],
"slots": [
{
"name": "",
"description": "Content of the dialog"
},
{
"name": "primaryAction",
"description": "Primary action of the dialog"
},
{
"name": "secondaryAction",
"description": "Secondary action of the dialog"
},
{
"name": "action",
"description": "Additional actions of the dialog which are displayed in the header"
},
{
"name": "footer",
"description": "Footer of the dialog"
}
],
"cssProperties": [
{
"name": "--mo-dialog-heading-color",
"description": "Color of the dialog heading"
},
{
"name": "--mo-dialog-content-color",
"description": "Color of the dialog content"
},
{
"name": "--mo-dialog-scrim-color",
"description": "Color of the dialog scrim"
},
{
"name": "--mo-dialog-divider-color",
"description": "Color of the dialog divider"
},
{
"name": "--mo-dialog-height",
"description": "Height of the dialog"
},
{
"name": "--mo-dialog-width",
"description": "Width of the dialog"
},
{
"name": "--mo-dialog-heading-line-height",
"description": "Line height of the dialog heading"
}
],
"cssParts": [
{
"name": "heading",
"description": "Dialog heading"
},
{
"name": "header",
"description": "Dialog footer"
},
{
"name": "content",
"description": "Dialog content"
},
{
"name": "footer",
"description": "Dialog footer"
}
]
},
{
"name": "mo-page",
"path": ".\\packages\\Dialog\\Page.ts",
"attributes": [
{
"name": "heading",
"description": "The page heading",
"type": "string",
"default": "\"\""
},
{
"name": "fullHeight",
"description": "Whether the page should take up the full height of the viewport",
"type": "boolean",
"default": "false"
},
{
"name": "headerHidden",
"description": "Whether the page header should be hidden",
"type": "boolean",
"default": "false"
}
],
"properties": [
{
"name": "pageHeadingChange",
"type": "EventDispatcher<string>"
},
{
"name": "heading",
"attribute": "heading",
"description": "The page heading",
"type": "string",
"default": "\"\""
},
{
"name": "fullHeight",
"attribute": "fullHeight",
"description": "Whether the page should take up the full height of the viewport",
"type": "boolean",
"default": "false"
},
{
"name": "headerHidden",
"attribute": "headerHidden",
"description": "Whether the page header should be hidden",
"type": "boolean",
"default": "false"
}
],
"events": [
{
"name": "pageHeadingChange",
"description": "Dispatched when the page heading changes",
"type": "CustomEvent<string>"
}
],
"slots": [
{
"name": "",
"description": "The page content"
},
{
"name": "heading",
"description": "The page heading"
},
{
"name": "action",
"description": "The page action"
}
],
"cssParts": [
{
"name": "header",
"description": "The page header"
},
{
"name": "heading",
"description": "The page heading"
},
{
"name": "action",
"description": "The page action"
}
]
},
{
"name": "mo-dialog",
"path": ".\\packages\\Dialog\\dist\\Dialog.d.ts",
"attributes": [
{
"name": "size",
"type": "DialogSize"
},
{
"name": "blocking",
"type": "boolean"
},
{
"name": "primaryButtonText",
"type": "string | undefined"
},
{
"name": "secondaryButtonText",
"type": "string | undefined"
},
{
"name": "open",
"type": "boolean"
},
{
"name": "primaryOnEnter",
"type": "boolean"
},
{
"name": "poppable",
"type": "boolean"
},
{
"name": "boundToWindow",
"type": "boolean"
},
{
"name": "manualClose",
"type": "boolean"
},
{
"name": "heading",
"type": "string"
}
],
"properties": [
{
"name": "executingActionAdaptersByComponent",
"type": "Map<Constructor<HTMLElement>, (actionElement: HTMLElement, isExecuting: boolean) => void>"
},
{
"name": "size",
"attribute": "size",
"type": "DialogSize"
},
{
"name": "blocking",
"attribute": "blocking",
"type": "boolean"
},
{
"name": "primaryButtonText",
"attribute": "primaryButtonText",
"type": "string | undefined"
},
{
"name": "secondaryButtonText",
"attribute": "secondaryButtonText",
"type": "string | undefined"
},
{
"name": "open",
"attribute": "open",
"type": "boolean"
},
{
"name": "topLayerElement",
"type": "ApplicationTopLayer"
},
{
"name": "primaryActionElement",
"type": "HTMLElement"
},
{
"name": "secondaryActionElement",
"type": "HTMLElement"
},
{
"name": "cancellationActionElement",
"type": "HTMLElement"
},
{
"name": "handleAction",
"type": "(key: DialogActionKey) => void | Promise<void>"
},
{
"name": "executingAction",
"type": "DialogActionKey | undefined"
},
{
"name": "preventCancellationOnEscape",
"type": "boolean"
},
{
"name": "primaryOnEnter",
"attribute": "primaryOnEnter",
"type": "boolean"
},
{
"name": "poppable",
"attribute": "poppable",
"type": "boolean"
},
{
"name": "boundToWindow",
"attribute": "boundToWindow",
"type": "boolean"
},
{
"name": "requestPopup",
"type": "EventDispatcher<void>"
},
{
"name": "manualClose",
"attribute": "manualClose",
"type": "boolean"
},
{
"name": "errorHandler",
"type": "DialogErrorHandler | undefined"
},
{
"name": "pageHeadingChange",
"description": "The event must be \"composed\", \"bubbles\" and \"cancellable\"",
"type": "EventDispatcher<string>"
},
{
"name": "heading",
"attribute": "heading",
"type": "string"
}
],
"events": [
{
"name": "pageHeadingChange",
"description": "Dispatched when the dialog heading changes",
"type": "CustomEvent<string>"
},
{
"name": "requestPopup",
"description": "Dispatched when the dialog is requested to be popped up",
"type": "CustomEvent<void>"
}
],
"slots": [
{
"name": "",
"description": "Content of the dialog"
},
{
"name": "primaryAction",
"description": "Primary action of the dialog"
},
{
"name": "secondaryAction",
"description": "Secondary action of the dialog"
},
{
"name": "action",
"description": "Additional actions of the dialog which are displayed in the header"
},
{
"name": "footer",
"description": "Footer of the dialog"
}
],
"cssProperties": [
{
"name": "--mo-dialog-heading-color",
"description": "Color of the dialog heading"
},
{
"name": "--mo-dialog-content-color",
"description": "Color of the dialog content"
},
{
"name": "--mo-dialog-scrim-color",
"description": "Color of the dialog scrim"
},
{
"name": "--mo-dialog-divider-color",
"description": "Color of the dialog divider"
},
{
"name": "--mo-dialog-height",
"description": "Height of the dialog"
},
{
"name": "--mo-dialog-width",
"description": "Width of the dialog"
},
{
"name": "--mo-dialog-heading-line-height",
"description": "Line height of the dialog heading"
}
],
"cssParts": [
{
"name": "heading",
"description": "Dialog heading"
},
{
"name": "header",
"description": "Dialog footer"
},
{
"name": "content",
"description": "Dialog content"
},
{
"name": "footer",
"description": "Dialog footer"
}
]
},
{
"name": "mo-page",
"path": ".\\packages\\Dialog\\dist\\Page.d.ts",
"attributes": [
{
"name": "heading",
"description": "The page heading",
"type": "string"
},
{
"name": "fullHeight",
"description": "Whether the page should take up the full height of the viewport",
"type": "boolean"
},
{
"name": "headerHidden",
"description": "Whether the page header should be hidden",
"type": "boolean"
}
],
"properties": [
{
"name": "pageHeadingChange",
"type": "EventDispatcher<string>"
},
{
"name": "heading",
"attribute": "heading",
"description": "The page heading",
"type": "string"
},
{
"name": "fullHeight",
"attribute": "fullHeight",
"description": "Whether the page should take up the full height of the viewport",
"type": "boolean"
},
{
"name": "headerHidden",
"attribute": "headerHidden",
"description": "Whether the page header should be hidden",
"type": "boolean"
}
],
"events": [
{
"name": "pageHeadingChange",
"description": "Dispatched when the page heading changes",
"type": "CustomEvent<string>"
}
],
"slots": [
{
"name": "",
"description": "The page content"
},
{
"name": "heading",
"description": "The page heading"
},
{
"name": "action",
"description": "The page action"
}
],
"cssParts": [
{
"name": "header",
"description": "The page header"
},
{
"name": "heading",
"description": "The page heading"
},
{
"name": "action",
"description": "The page action"
}
]
}
]
}