Skip to main content

LgButton

Module : Lagoon.UI
Namespace : Lagoon.UI.Components
Category: Button
Inherits from: LgAriaComponentBase

Component button.

Parameters​

ParameterTypeDescription
AdditionalAttributesIReadOnlyDictionary<string, object>Gets or sets a collection of additional attributes that will be applied to the created element.
AutoFocusboolGets or sets if the component received the focus on first render
ButtonSizeButtonSize?Gets or sets the button size.
ChildContentRenderFragmentButton custom content
CommandArgumentobjectThe argument value associated to the command.
CommandNamestringThe name of the command to send to the handler of commands.
ConfirmationMessagestringGets or sets the confirmation message to show before doing the action. Warning : Don't work with the CommandName parameter.
CssClassstringGets or sets the CSS class
DisabledboolGets or sets the disabled attribute.
IconNamestringGets or sets the button icon name
IsSubmitboolGet or set if the button type is "submit".
KindButtonKindGets or sets the kind of the button
LinkLgPageLinkInformations to create link to specific page.
OnClickEventCallback<ActionEventArgs>Gets or sets the button Onclick eventCallback
PolicyEditstringNot implemented for button
PolicyVisiblestringPolicy required to view the Button
PreventDefaultboolGets or sets the button prevent default
PreventDoubleClickboolDisable button when executing an action.
ShortcutKeystringGets or sets the character associated with CTRL that trigger the button click.
StopPropagationboolGets or sets the button stop propagation
TargetstringThe name of the browser window in which the URI should be opened.
TextstringGets or sets the button label
TooltipstringGets or sets the tooltip.
TooltipIsHtmlboolGets or sets if the tooltip contents use the HTML format; else, the content use a raw text format.
TooltipPositionTooltipPositionPosition de la bulle d'aide.
UristringThe URI to open.

Cascading parameters​

ParameterTypeDescription
ButtonSizeCascadingButtonSize?The button size cascading from an ancestor, used if the ButtonSize parameter is not set.
EditFormLgEditFormAn optional parent LgEditForm
ParentAuthorizeViewLgAuthorizeViewPotential policies defined by an ancestor

Parameters inherited from LgAriaComponentBase​

ParameterTypeDescription
AriaLabelstringGets or sets aria label
AriaLabelledBystringGets or sets id of component for aria label