BitstylesPhoenix.Live.Sidebar (bitstyles_phoenix v2.3.0) View Source

Components for rendering a sidebar layout powered by LiveView commands.

Link to this section Summary

Functions

A sidebar close icon to be rendered on the open sidebar for closing the sidebar.

Renders a sidebar layout with LiveView commands.

A sidebar open icon to be rendered on the main content for opening the sidebar.

Link to this section Functions

Link to this function

ui_js_sidebar_close(assigns)

View Source

A sidebar close icon to be rendered on the open sidebar for closing the sidebar.

Attributes

  • label - A screen reader label for the icon. Defaults to "Close".
  • sidebar - The reference to the sidebar it controls. This will be the sidebar id. The ui_js_sidebar_layout/1 can provide this as a block argument in the small sidebar block.
Link to this function

ui_js_sidebar_layout(assigns)

View Source

Renders a sidebar layout with LiveView commands.

Supports all attributes and slots from BitstylesPhoenix.Component.Sidebar.ui_sidebar_layout/1.

The small_sidebar and main/inner blocks will additionally provide a block argument with the sidebar context for ui_js_sidebar_open/1 and ui_js_sidebar_close/1.

For examles see BitstylesPhoenix.Component.Sidebar.ui_sidebar_layout/1.

Link to this function

ui_js_sidebar_open(assigns)

View Source

A sidebar open icon to be rendered on the main content for opening the sidebar.

Attributes

  • label - A screen reader label for the icon. Defaults to "Open sidebar".
  • sidebar - The reference to the sidebar it controls. This will be the sidebar id. The ui_js_sidebar_layout/1 can provide this as a block argument in the main or inner block.