@aurelia-mdc-web/all 9.2.2-au2 → 9.3.0-au2

package/src/banner/doc/api.json

@@ -0,0 +1,1106 @@
+{
+	"id": 0,
+	"name": "aurelia-mdc-web-docs",
+	"kind": 1,
+	"kindString": "Project",
+	"flags": {},
+	"children": [
+		{
+			"id": 6,
+			"name": "MdcBanner",
+			"kind": 128,
+			"kindString": "Class",
+			"flags": {},
+			"comment": {
+				"tags": [
+					{
+						"tag": "selector",
+						"text": "mdc-banner\n"
+					}
+				]
+			},
+			"decorators": [
+				{
+					"name": "inject",
+					"type": {
+						"type": "reference",
+						"name": "inject"
+					},
+					"arguments": {
+						"dependencies": "Element"
+					}
+				},
+				{
+					"name": "customElement",
+					"type": {
+						"type": "reference",
+						"name": "customElement"
+					},
+					"arguments": {
+						"name": "'mdc-banner'"
+					}
+				},
+				{
+					"name": "processContent",
+					"type": {
+						"type": "reference",
+						"name": "processContent"
+					},
+					"arguments": {
+						"hook": "defaultSlotProcessContent"
+					}
+				}
+			],
+			"children": [
+				{
+					"id": 7,
+					"name": "constructor",
+					"kind": 512,
+					"kindString": "Constructor",
+					"flags": {},
+					"signatures": [
+						{
+							"id": 8,
+							"name": "new MdcBanner",
+							"kind": 16384,
+							"kindString": "Constructor signature",
+							"flags": {},
+							"parameters": [
+								{
+									"id": 9,
+									"name": "root",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {},
+									"type": {
+										"type": "reference",
+										"name": "HTMLElement"
+									}
+								}
+							],
+							"type": {
+								"type": "reference",
+								"id": 6,
+								"name": "MdcBanner"
+							},
+							"inheritedFrom": {
+								"type": "reference",
+								"name": "MdcComponent<MDCBannerFoundation>.constructor"
+							}
+						}
+					],
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "MdcComponent<MDCBannerFoundation>.constructor"
+					}
+				},
+				{
+					"id": 13,
+					"name": "centered",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {},
+					"comment": {
+						"shortText": "Displayed banner centered, optional"
+					},
+					"decorators": [
+						{
+							"name": "bindable",
+							"type": {
+								"type": "reference",
+								"name": "bindable"
+							},
+							"arguments": {
+								"config": "{ set: booleanAttr }"
+							}
+						}
+					],
+					"sources": [
+						{
+							"fileName": "banner/src/mdc-banner.ts",
+							"line": 27,
+							"character": 2
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "boolean"
+					}
+				},
+				{
+					"id": 10,
+					"name": "contentEl",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isPrivate": true
+					},
+					"sources": [
+						{
+							"fileName": "banner/src/mdc-banner.ts",
+							"line": 18,
+							"character": 10
+						}
+					],
+					"type": {
+						"type": "reference",
+						"name": "HTMLElement"
+					}
+				},
+				{
+					"id": 12,
+					"name": "fixed",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {},
+					"comment": {
+						"shortText": "When used below top app bars, banners should remain fixed at the top of the screen"
+					},
+					"decorators": [
+						{
+							"name": "bindable",
+							"type": {
+								"type": "reference",
+								"name": "bindable"
+							},
+							"arguments": {
+								"config": "{ set: booleanAttr }"
+							}
+						}
+					],
+					"sources": [
+						{
+							"fileName": "banner/src/mdc-banner.ts",
+							"line": 23,
+							"character": 2
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "boolean"
+					}
+				},
+				{
+					"id": 29,
+					"name": "foundation",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "base/src/mdc-component.ts",
+							"line": 6,
+							"character": 2
+						}
+					],
+					"type": {
+						"type": "reference",
+						"name": "MDCBannerFoundation"
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "MdcComponent.foundation"
+					}
+				},
+				{
+					"id": 14,
+					"name": "icon",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {},
+					"comment": {
+						"shortText": "Sets banner icon"
+					},
+					"decorators": [
+						{
+							"name": "bindable",
+							"type": {
+								"type": "reference",
+								"name": "bindable"
+							}
+						}
+					],
+					"sources": [
+						{
+							"fileName": "banner/src/mdc-banner.ts",
+							"line": 31,
+							"character": 2
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				},
+				{
+					"id": 30,
+					"name": "initialised",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "base/src/mdc-component.ts",
+							"line": 8,
+							"character": 2
+						}
+					],
+					"type": {
+						"type": "reference",
+						"typeArguments": [
+							{
+								"type": "intrinsic",
+								"name": "unknown"
+							}
+						],
+						"name": "Promise"
+					},
+					"defaultValue": "...",
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "MdcComponent.initialised"
+					}
+				},
+				{
+					"id": 31,
+					"name": "initialisedResolve",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isProtected": true
+					},
+					"sources": [
+						{
+							"fileName": "base/src/mdc-component.ts",
+							"line": 9,
+							"character": 12
+						}
+					],
+					"type": {
+						"type": "reflection",
+						"declaration": {
+							"id": 32,
+							"name": "__type",
+							"kind": 65536,
+							"kindString": "Type literal",
+							"flags": {},
+							"signatures": [
+								{
+									"id": 33,
+									"name": "__type",
+									"kind": 4096,
+									"kindString": "Call signature",
+									"flags": {},
+									"parameters": [
+										{
+											"id": 34,
+											"name": "value",
+											"kind": 32768,
+											"kindString": "Parameter",
+											"flags": {
+												"isOptional": true
+											},
+											"type": {
+												"type": "intrinsic",
+												"name": "unknown"
+											}
+										}
+									],
+									"type": {
+										"type": "intrinsic",
+										"name": "void"
+									}
+								}
+							]
+						}
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "MdcComponent.initialisedResolve"
+					}
+				},
+				{
+					"id": 11,
+					"name": "mdcFocusTrap",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isPrivate": true
+					},
+					"sources": [
+						{
+							"fileName": "banner/src/mdc-banner.ts",
+							"line": 19,
+							"character": 10
+						}
+					],
+					"type": {
+						"type": "reference",
+						"name": "MdcFocusTrap"
+					}
+				},
+				{
+					"id": 15,
+					"name": "primaryAction",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {},
+					"comment": {
+						"shortText": "Sets the banner primary action text"
+					},
+					"decorators": [
+						{
+							"name": "bindable",
+							"type": {
+								"type": "reference",
+								"name": "bindable"
+							}
+						}
+					],
+					"sources": [
+						{
+							"fileName": "banner/src/mdc-banner.ts",
+							"line": 35,
+							"character": 2
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				},
+				{
+					"id": 28,
+					"name": "root",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isPublic": true
+					},
+					"type": {
+						"type": "reference",
+						"name": "HTMLElement"
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "MdcComponent.root"
+					}
+				},
+				{
+					"id": 16,
+					"name": "secondaryAction",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {},
+					"comment": {
+						"shortText": "Sets the banner secondary action text"
+					},
+					"decorators": [
+						{
+							"name": "bindable",
+							"type": {
+								"type": "reference",
+								"name": "bindable"
+							}
+						}
+					],
+					"sources": [
+						{
+							"fileName": "banner/src/mdc-banner.ts",
+							"line": 39,
+							"character": 2
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				},
+				{
+					"id": 39,
+					"name": "attached",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "base/src/mdc-component.ts",
+							"line": 21,
+							"character": 2
+						}
+					],
+					"signatures": [
+						{
+							"id": 40,
+							"name": "attached",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"type": {
+								"type": "intrinsic",
+								"name": "void"
+							},
+							"inheritedFrom": {
+								"type": "reference",
+								"name": "MdcComponent.attached"
+							}
+						}
+					],
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "MdcComponent.attached"
+					}
+				},
+				{
+					"id": 37,
+					"name": "beforeFoundationCreated",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "base/src/mdc-component.ts",
+							"line": 19,
+							"character": 2
+						}
+					],
+					"signatures": [
+						{
+							"id": 38,
+							"name": "beforeFoundationCreated",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"type": {
+								"type": "intrinsic",
+								"name": "void"
+							},
+							"inheritedFrom": {
+								"type": "reference",
+								"name": "MdcComponent.beforeFoundationCreated"
+							}
+						}
+					],
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "MdcComponent.beforeFoundationCreated"
+					}
+				},
+				{
+					"id": 23,
+					"name": "close",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "banner/src/mdc-banner.ts",
+							"line": 66,
+							"character": 2
+						}
+					],
+					"signatures": [
+						{
+							"id": 24,
+							"name": "close",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"comment": {
+								"shortText": "Closes the banner and fires events.CLOSING to indicate the beginning of its\nclosing animation and then events.CLOSED once the animation finishes."
+							},
+							"parameters": [
+								{
+									"id": 25,
+									"name": "reason",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {},
+									"comment": {
+										"shortText": "Why the banner was closed. Value will be passed to\n    events.CLOSING and events.CLOSED via the `event.detail.reason`\n    property. Standard values are CloseReason.PRIMARY and\n    CloseReason.SECONDARY, but CloseReason.UNSPECIFIED is provided for\n    custom handling of programmatic closing of the banner.\n"
+									},
+									"type": {
+										"type": "reference",
+										"name": "CloseReason"
+									}
+								}
+							],
+							"type": {
+								"type": "intrinsic",
+								"name": "void"
+							}
+						}
+					]
+				},
+				{
+					"id": 41,
+					"name": "destroy",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "base/src/mdc-component.ts",
+							"line": 30,
+							"character": 2
+						}
+					],
+					"signatures": [
+						{
+							"id": 42,
+							"name": "destroy",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"type": {
+								"type": "intrinsic",
+								"name": "void"
+							},
+							"inheritedFrom": {
+								"type": "reference",
+								"name": "MdcComponent.destroy"
+							}
+						}
+					],
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "MdcComponent.destroy"
+					}
+				},
+				{
+					"id": 43,
+					"name": "detaching",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "base/src/mdc-component.ts",
+							"line": 32,
+							"character": 2
+						}
+					],
+					"signatures": [
+						{
+							"id": 44,
+							"name": "detaching",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"type": {
+								"type": "intrinsic",
+								"name": "void"
+							},
+							"inheritedFrom": {
+								"type": "reference",
+								"name": "MdcComponent.detaching"
+							}
+						}
+					],
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "MdcComponent.detaching"
+					}
+				},
+				{
+					"id": 26,
+					"name": "getDefaultFoundation",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "banner/src/mdc-banner.ts",
+							"line": 70,
+							"character": 2
+						}
+					],
+					"signatures": [
+						{
+							"id": 27,
+							"name": "getDefaultFoundation",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"type": {
+								"type": "reference",
+								"name": "MDCBannerFoundation"
+							},
+							"overwrites": {
+								"type": "reference",
+								"name": "MdcComponent.getDefaultFoundation"
+							}
+						}
+					],
+					"overwrites": {
+						"type": "reference",
+						"name": "MdcComponent.getDefaultFoundation"
+					}
+				},
+				{
+					"id": 17,
+					"name": "handlePrimaryActionClick",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "banner/src/mdc-banner.ts",
+							"line": 41,
+							"character": 2
+						}
+					],
+					"signatures": [
+						{
+							"id": 18,
+							"name": "handlePrimaryActionClick",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"type": {
+								"type": "intrinsic",
+								"name": "void"
+							}
+						}
+					]
+				},
+				{
+					"id": 19,
+					"name": "handleSecondaryActionClick",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "banner/src/mdc-banner.ts",
+							"line": 45,
+							"character": 2
+						}
+					],
+					"signatures": [
+						{
+							"id": 20,
+							"name": "handleSecondaryActionClick",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"type": {
+								"type": "intrinsic",
+								"name": "void"
+							}
+						}
+					]
+				},
+				{
+					"id": 35,
+					"name": "initialSyncWithDOM",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "base/src/mdc-component.ts",
+							"line": 16,
+							"character": 2
+						}
+					],
+					"signatures": [
+						{
+							"id": 36,
+							"name": "initialSyncWithDOM",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"type": {
+								"type": "intrinsic",
+								"name": "void"
+							},
+							"inheritedFrom": {
+								"type": "reference",
+								"name": "MdcComponent.initialSyncWithDOM"
+							}
+						}
+					],
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "MdcComponent.initialSyncWithDOM"
+					}
+				},
+				{
+					"id": 45,
+					"name": "listen",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "base/src/mdc-component.ts",
+							"line": 41,
+							"character": 2
+						}
+					],
+					"signatures": [
+						{
+							"id": 46,
+							"name": "listen",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"parameters": [
+								{
+									"id": 47,
+									"name": "evtType",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {},
+									"type": {
+										"type": "intrinsic",
+										"name": "string"
+									}
+								},
+								{
+									"id": 48,
+									"name": "handler",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {},
+									"type": {
+										"type": "union",
+										"types": [
+											{
+												"type": "reference",
+												"name": "EventListener"
+											},
+											{
+												"type": "reference",
+												"name": "EventListenerObject"
+											}
+										]
+									}
+								},
+								{
+									"id": 49,
+									"name": "options",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {
+										"isOptional": true
+									},
+									"type": {
+										"type": "union",
+										"types": [
+											{
+												"type": "intrinsic",
+												"name": "boolean"
+											},
+											{
+												"type": "reference",
+												"name": "AddEventListenerOptions"
+											}
+										]
+									}
+								}
+							],
+							"type": {
+								"type": "intrinsic",
+								"name": "void"
+							},
+							"inheritedFrom": {
+								"type": "reference",
+								"name": "MdcComponent.listen"
+							}
+						}
+					],
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "MdcComponent.listen"
+					}
+				},
+				{
+					"id": 21,
+					"name": "open",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "banner/src/mdc-banner.ts",
+							"line": 53,
+							"character": 2
+						}
+					],
+					"signatures": [
+						{
+							"id": 22,
+							"name": "open",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"comment": {
+								"shortText": "Opens the banner and fires events.OPENING to indicate the beginning of its\nopening animation and then events.OPENED once the animation finishes."
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "void"
+							}
+						}
+					]
+				},
+				{
+					"id": 50,
+					"name": "unlisten",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "base/src/mdc-component.ts",
+							"line": 45,
+							"character": 2
+						}
+					],
+					"signatures": [
+						{
+							"id": 51,
+							"name": "unlisten",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"parameters": [
+								{
+									"id": 52,
+									"name": "evtType",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {},
+									"type": {
+										"type": "intrinsic",
+										"name": "string"
+									}
+								},
+								{
+									"id": 53,
+									"name": "handler",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {},
+									"type": {
+										"type": "union",
+										"types": [
+											{
+												"type": "reference",
+												"name": "EventListener"
+											},
+											{
+												"type": "reference",
+												"name": "EventListenerObject"
+											}
+										]
+									}
+								},
+								{
+									"id": 54,
+									"name": "options",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {
+										"isOptional": true
+									},
+									"type": {
+										"type": "union",
+										"types": [
+											{
+												"type": "intrinsic",
+												"name": "boolean"
+											},
+											{
+												"type": "reference",
+												"name": "AddEventListenerOptions"
+											}
+										]
+									}
+								}
+							],
+							"type": {
+								"type": "intrinsic",
+								"name": "void"
+							},
+							"inheritedFrom": {
+								"type": "reference",
+								"name": "MdcComponent.unlisten"
+							}
+						}
+					],
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "MdcComponent.unlisten"
+					}
+				}
+			],
+			"groups": [
+				{
+					"title": "Constructors",
+					"kind": 512,
+					"children": [
+						7
+					]
+				},
+				{
+					"title": "Properties",
+					"kind": 1024,
+					"children": [
+						13,
+						10,
+						12,
+						29,
+						14,
+						30,
+						31,
+						11,
+						15,
+						28,
+						16
+					]
+				},
+				{
+					"title": "Methods",
+					"kind": 2048,
+					"children": [
+						39,
+						37,
+						23,
+						41,
+						43,
+						26,
+						17,
+						19,
+						35,
+						45,
+						21,
+						50
+					]
+				}
+			],
+			"sources": [
+				{
+					"fileName": "banner/src/mdc-banner.ts",
+					"line": 17,
+					"character": 13
+				}
+			],
+			"extendedTypes": [
+				{
+					"type": "reference",
+					"typeArguments": [
+						{
+							"type": "reference",
+							"name": "MDCBannerFoundation"
+						}
+					],
+					"name": "MdcComponent"
+				}
+			]
+		},
+		{
+			"id": 1,
+			"name": "BannerConfiguration",
+			"kind": 32,
+			"kindString": "Variable",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "banner/src/index.ts",
+					"line": 7,
+					"character": 13
+				}
+			],
+			"type": {
+				"type": "reflection",
+				"declaration": {
+					"id": 2,
+					"name": "__type",
+					"kind": 65536,
+					"kindString": "Type literal",
+					"flags": {},
+					"children": [
+						{
+							"id": 3,
+							"name": "register",
+							"kind": 2048,
+							"kindString": "Method",
+							"flags": {},
+							"sources": [
+								{
+									"fileName": "banner/src/index.ts",
+									"line": 8,
+									"character": 2
+								}
+							],
+							"signatures": [
+								{
+									"id": 4,
+									"name": "register",
+									"kind": 4096,
+									"kindString": "Call signature",
+									"flags": {},
+									"parameters": [
+										{
+											"id": 5,
+											"name": "container",
+											"kind": 32768,
+											"kindString": "Parameter",
+											"flags": {},
+											"type": {
+												"type": "reference",
+												"name": "IContainer"
+											}
+										}
+									],
+									"type": {
+										"type": "reference",
+										"name": "IContainer"
+									}
+								}
+							]
+						}
+					],
+					"groups": [
+						{
+							"title": "Methods",
+							"kind": 2048,
+							"children": [
+								3
+							]
+						}
+					]
+				}
+			},
+			"defaultValue": "..."
+		}
+	],
+	"groups": [
+		{
+			"title": "Classes",
+			"kind": 128,
+			"children": [
+				6
+			]
+		},
+		{
+			"title": "Variables",
+			"kind": 32,
+			"children": [
+				1
+			]
+		}
+	],
+	"sources": [
+		{
+			"fileName": "banner/src/index.ts",
+			"line": 1,
+			"character": 0
+		}
+	]
+}