Defines a label.

Provides similar capabilities to Phoenix's built-in label/2 function.

Option class can be set directly and will override anything in opts.

All given options are forwarded to the underlying tag. A default value is provided for for attribute but can be overridden if you pass a value to the for option. Text content would be inferred from field if not specified.

Properties

• values :keyword, default: [] - List values that will be sent as part of the payload triggered by an event

• form :form, from_context: {Surface.Components.Form, :form} - The form identifier

• field :any, from_context: {Surface.Components.Form.Field, :field} - The field name

• class :css_class - The CSS class for the underlying tag

• text :any - The text for the generated <label> element, if no content (default slot) is provided.

• opts :keyword, default: [] - Options list

Slots

• default - The text for the label

Events

• click - Triggered when the component receives click
• click_away - Triggered when a click event happens outside of the element
• capture_click - Triggered when the component captures click
• blur - Triggered when the component loses focus
• focus - Triggered when the component receives focus
• window_blur - Triggered when the page loses focus
• window_focus - Triggered when the page receives focus
• keydown - Triggered when a key on the keyboard is pressed
• keyup - Triggered when a key on the keyboard is released
• window_keydown - Triggered when a key on the keyboard is pressed (window-level)
• window_keyup - Triggered when a key on the keyboard is released (window-level)