BwView | bw-view

Overview

Views are a generic layout for displaying an entire page worth of content. They are primarily meant to be used inside overlays, but they could be used to format any standalone information.

For examples on how to use views, read the wizard tutorial.

Properties

Property	Attribute	Description	Type	Default
`closable`	`closable`	Renders a close button at the end of the header that will auto close a parent overlay if it exists	`boolean`	`true`
`crumbs`	--	This is set by a parent bw-view-manager if it exists. Do not set directly	`string[]`	`[]`
`destroy`	--	Execute a callback after the view has dismissed. Only applicable when used inside a view manager	`() => void \| Promise<void>`	`undefined`
`form`	`form`	Set this to the id of a bw-form if you need the close button to trigger a discard changes prompt.	`string`	`undefined`
`init`	--	Execute a callback before the view starts presenting. Only applicable when used inside a view manager	`() => void \| Promise<void>`	`undefined`
`label`	`label`	The header of the view	`string`	`undefined`
`noHeader`	`no-header`	Whether or not the header slot should be rendered	`boolean`	`false`
`showWizard`	`show-wizard`	Whether or not this view should show the wizard. Only applies if being used in a bw-view-manager.	`boolean`	`false`
`steps`	--	This is set by a parent bw-view-manager if it exists. Do not set directly	`WizardStep[]`	`[]`

Methods

`getWizardElement() => Promise<HTMLBwWizardElement>`

Returns the inner HTMLBwWizardElement

Returns

Type: Promise<HTMLBwWizardElement>

Slots

Slot	Description
	Pass the main content of the view in the default slot
`"footer"`	pass bw-buttons in here, they will appear in a sticky footer at the bottom of the view
`"header"`	The entire header is wrapped in this slot. If you pass in this slot manually, you will overwrite the entire header of the view with your custom markup
`"header-end"`	Items placed here will show up at the end of the header and before the close button
`"header-start"`	Items placed here will show up before the label
`"label"`	You can override the header label with this slot
`"options"`	Items placed here will show in a popover at the end of the header. You should only pass in bw-options

BwView | bw-view

Overview

Properties

Methods

`getWizardElement() => Promise<HTMLBwWizardElement>`

Returns

Slots

Dependencies

Used by

Depends on

Graph

Overview​

Properties​

Methods​

getWizardElement() => Promise<HTMLBwWizardElement>​

Returns​

Slots​

Dependencies​

Used by​

Depends on​

Graph​

Overview

Properties

Methods

`getWizardElement() => Promise<HTMLBwWizardElement>`

Returns

Slots

Dependencies

Used by

Depends on

Graph