API Reference surface_bootstrap v0.2.5

Modules

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Can take a list of breadcrumb maps with keys url, text and active or a slot list of Breadcrumb.Item.

Renderless holder of Breadcrumb.Item data.

Group of buttons.

Card component.

Card body component

Card body text component

Card title component

Card footer slot

Card header slot

Card image overlay component

Catalogue implementation for SurfaceBootstrap.

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Properties

  • id :string, required: true - The id of the live view.
  • session :map - The request info necessary for the view, such as params, cookie session info, etc. The session is signed and stored on the client, then provided back to the server when the client connects, or reconnects to the stateful view. .

Column utility component, emits a <div> wrapper for columns.

A container class, lets you set breakpoints to adjust to mobile views etc.

The dropdown component.

Defines an Item for the Dropdown. This component supports the following slot content

Field that holds common markup for form controls.

The checkbox component

A text input of type "color", as defined here

The date input element as defined here

The local datetime input element as defined here

The email input element as defined here

The file input component as defined here

The number input element as defined here

The password field component as defined here

The range input element as defined here

The select component as defined here

The number input element as defined here

The time input element as defined here

The url input element as defined here

Bootstrap icons, requires installation or CDN usage, see: https://icons.getbootstrap.com/#install

The Bootstrap modal, with various configuration options.

The NavBar component.

ItemGroup is a wrapper element, mainly used to adjust items left, center or right.

To be used inside NavBar.ItemGroup and emits as a <li class="nav-item"> wrapper.

Properties

  • target_id :string, required: true - Target of collapser button.
  • aria_label :string - Aria label of toggler.
  • class :css_class, default: [] - Any classes to put on the toggler.
  • style :string - Custom styles to put on the button.

Row utility component, emits a <div> wrapper.

Tab component.

Defines an Item for Tab.

Defines a column for the parent table component.

Tooltip component, is used to initialize a tooltip on a child