@revealbi/ui
Version:
189 lines (188 loc) • 6.21 kB
JSON
{
"schemaVersion": "1.0.0",
"readme": "",
"modules": [
{
"kind": "javascript-module",
"path": "src/components/dialog/dialog.component.ts",
"declarations": [
{
"kind": "class",
"description": "",
"name": "RvDialog",
"cssProperties": [
{
"description": "The preferred width of the dialog. Note that the dialog will shrink to accommodate smaller screens.",
"name": "--width"
},
{
"description": "The amount of padding to use for the header.",
"name": "--header-spacing"
},
{
"description": "The amount of padding to use for the body.",
"name": "--body-spacing"
},
{
"description": "The amount of padding to use for the footer.",
"name": "--footer-spacing"
}
],
"cssParts": [
{
"description": "The overlay that covers the screen behind the dialog.",
"name": "overlay"
},
{
"description": "The dialog's panel (where the dialog and its content are rendered).",
"name": "panel"
},
{
"description": "The dialog's header. This element wraps the title and header actions.",
"name": "header"
},
{
"description": "Optional actions to add to the header.",
"name": "header-actions"
},
{
"description": "The dialog's title.",
"name": "title"
},
{
"description": "The close button.",
"name": "close-button"
},
{
"description": "The dialog's content.",
"name": "content"
},
{
"description": "The dialog's footer.",
"name": "footer"
}
],
"slots": [
{
"description": "The dialog's main content.",
"name": "default"
},
{
"description": "Optional actions to add to the header.",
"name": "header-actions"
},
{
"description": "The dialog's footer, usually one or more buttons representing various options.",
"name": "footer"
}
],
"members": [
{
"kind": "field",
"name": "title",
"type": {
"text": "string"
},
"default": "\"\"",
"description": "The dialog's title as displayed in the header.",
"attribute": "title"
},
{
"kind": "field",
"name": "open",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Indicates whether or not the dialog is open. You can toggle this attribute to show and hide the dialog, or you can\nuse the `show()` and `close()` methods and this attribute will reflect the dialog's open state.",
"attribute": "open",
"reflects": true
},
{
"kind": "field",
"name": "_closeResolver",
"type": {
"text": "(value: string | PromiseLike<any>) => void | undefined"
},
"privacy": "private"
},
{
"kind": "method",
"name": "show",
"return": {
"type": {
"text": "Promise<any>"
}
},
"description": "Shows the dialog."
},
{
"kind": "method",
"name": "close",
"parameters": [
{
"name": "source",
"type": {
"text": "any | \"close-button\" | \"overlay\""
},
"description": "The source of the close action. This can be a string or an object. The resolved value of the promise returned by `show()` will be this value."
}
],
"description": "Hides the dialog.",
"return": {
"type": {
"text": "void"
}
}
}
],
"attributes": [
{
"name": "title",
"type": {
"text": "string"
},
"default": "\"\"",
"description": "The dialog's title as displayed in the header.",
"fieldName": "title"
},
{
"name": "open",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Indicates whether or not the dialog is open. You can toggle this attribute to show and hide the dialog, or you can\nuse the `show()` and `close()` methods and this attribute will reflect the dialog's open state.",
"fieldName": "open"
}
],
"superclass": {
"name": "LitElement",
"package": "lit"
},
"summary": "Dialogs appear above the page and require the user's immediate attention. They inform users about critical information, require users to make decisions, or involve multiple tasks.",
"tagName": "rv-dialog",
"customElement": true
}
],
"exports": [
{
"kind": "js",
"name": "RvDialog",
"declaration": {
"name": "RvDialog",
"module": "src/components/dialog/dialog.component.ts"
}
},
{
"kind": "custom-element-definition",
"name": "rv-dialog",
"declaration": {
"name": "RvDialog",
"module": "src/components/dialog/dialog.component.ts"
}
}
]
}
]
}