V Vaylan UI
Navigation

Dock

Keep the most-used destinations within easy reach.

Preview

Choose an example destination. The preview updates locally without leaving this page.

Your workspace

Example

<.dock label="Primary"><:item label="Home" href="/">⌂</:item></.dock>

API contract

dock/1 uses declared Phoenix attributes and slots. This table is generated from the compiled component metadata.

AttributeTypeRequiredDefault Accepted values
label :string No "App navigation" Any value matching the declared type
size :atom No nil [nil, :xs, :sm, :md, :lg, :xl]
class :any No nil Any value matching the declared type
rest :global No — Any value matching the declared type
SlotRequiredSlot attributes
item Yes label: :string required, href: :string, active: :boolean

States and behavior

Default and caller-supplied variants preserve semantic daisyUI colors and additive classes.

Keyboard and accessibility

Behavioral tests

These automated checks are applied to this component by the package and documentation test suites.

  • ExUnit

    Dock navigation state

    Keeps a named navigation landmark and marks the active dock destination with aria-current.

    test/vaylan_ui/catalog_test.exs
  • Docs

    Preview behavior contract

    Classified as navigation. Choose an example destination. The preview updates locally without leaving this page.

    examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs
  • Docs

    Stable public component page

    Renders the component name, example, API contract, accepted values, and keyboard and accessibility guidance at its stable URL.

    examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs