button (Tobago Core VDL Documentation)

Description:
Renders a button element.
UIComponentClass: org.apache.myfaces.tobago.component.UIButton
RendererType:
- Button (default)
Supported facets:
confirmation
Contains a UIOutput instance with the confirmation message.
Supported markups:
primary
Set button color to primary color of the theme.
secondary
Set button color to secondary color of the theme.
success
Set button color to success color of the theme.
danger
Set button color to danger color of the theme.
warning
Set button color to warning color of the theme.
info
Set button color to info color of the theme.
light
Set button color to light color of the theme.
dark
Set button color to dark color of the theme.
outlinePrimary
Set button color to outline primary color of the theme.
outlineSecondary
Set button color to outline secondary color of the theme.
outlineSuccess
Set button color to outline success color of the theme.
outlineDanger
Set button color to outline danger color of the theme.
outlineWarning
Set button color to outline warning color of the theme.
outlineInfo
Set button color to outline info color of the theme.
outlineLight
Set button color to outline light color of the theme.
outlineDark
Set button color to outline dark color of the theme.
large
Render a large button.
small
Render a small button.
none
Colorless button.
badge
Display the button as a badge.
pill
Make badges more rounded if button is displayed as a badge.
hideToggleIcon
Hide the toggle icon of a dropdown menu.

Component Information
Info	Value
Component Type	`org.apache.myfaces.tobago.Button`
Handler Class	`org.apache.myfaces.tobago.facelets.TobagoComponentHandler`
Renderer Type	`Button`
Description	None

Attributes
Name	Required	Type	Description
`accessKey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Character`)	The access key of this control. Type: `java.lang.Character`
`action`	`false`	`java.lang.String`	Action to invoke when clicked. This must be a MethodExpression or a String representing the application action to invoke when this component is activated by the user. The {@link jakarta.el.MethodExpression} must evaluate to a public method that takes no parameters, and returns a {@link String} (the logical outcome) which is passed to the {@link jakarta.faces.application.NavigationHandler} for this application. The string is directly passed to the navigation handler.
`actionListener`	`false`	`java.lang.String`	MethodExpression representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.
`autoSpacing`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet Type: `java.lang.Boolean`
`binding`	`false`	`javax.el.ValueExpression` (must evaluate to `jakarta.faces.component.UIComponent`)	The value binding expression linking this component to a property in a backing bean. For Facelets, the component is the outer UIPanel, not the input control. Type: `jakarta.faces.component.UIComponent`
`confirmation`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Text to use as confirmation message. Type: `java.lang.String`
`defaultCommand`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	If true the command is executed as default -- for example if the user presses the enter key inside a related input field. Type: `boolean` Default: `false`
`disabled`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating that this element is disabled. If configured so in the tobago-config.xml the action will be checked for the annotations {@link jakarta.annotation.security.RolesAllowed}, {@link jakarta.annotation.security.PermitAll} or {@link jakarta.annotation.security.DenyAll}. Type: `boolean`
`fragment`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The identifier of the page fragment which should be brought into focus when the target page is rendered. The value of this attribute is appended to the end of target URL following a hash (#) mark. This notation is part of the standard URL syntax. Type: `java.lang.String`
`id`	`false`	`java.lang.String`	The component identifier for this component. This value must be unique within the closest parent component that is a naming container. Type: `java.lang.String`
`image`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Url to an image to display. Type: `java.lang.String`
`immediate`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase. Type: `boolean` Default: `false`
`label`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A localized user presentable label for this component. Type: `java.lang.String`
`link`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Link to an arbitrary URL, either an internal link or an external link. For internal URLs, a session id will be added, if needed (when cookies disabled). The context path needs to be added manually e.g. #{request.contextPath}. For JSF navigation to a viewId use the outcome attribute! The semantic of this attributes has been changed from Tobago 3 to 4! Type: `java.lang.String`
`markup`	`false`	`javax.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.context.Markup`)	Indicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer. Type: `org.apache.myfaces.tobago.context.Markup`
`omit`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating that the action of this element, will not be executed from client side (e. g. when the user clicks a button. When setting this value to true, the action will not be executed by the Tobago, but it can executed by JavaScript. This attribute is useful, when you want to add JavaScript event handlers to commands manually. In this case you usually don't want a submit with a full reload of the page. Type: `boolean` Default: `false`
`outcome`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Link to an internal facelet page, like the outcome of an action. The context path will be added. A session id will be added, if needed. Type: `java.lang.String`
`rendered`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. Type: `boolean` Default: `true`
`tabIndex`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Controls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order. Type: `java.lang.Integer`
`target`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of a frame where the resource retrieved via this hyperlink is to be displayed. Type: `java.lang.String`
`tip`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Text value to display as tooltip. Type: `java.lang.String`
`transition`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior. Type: `boolean` Default: `true`

tc

Tag button