EnInputButtonGroup
Preview
Props
| Name | Description | Default | Control |
|---|---|---|---|
| justifyButtons | Stretches buttons horizontally to fill all available space. boolean | false | |
| small | Renders a compact group, for a segmented control that sits inside a panel heading or beside a label rather than standing alone in a form. boolean | false | |
| value | Used for a raw value passed into the input. string | number | unknown | |
| name | Sets name attribute for the input. Required for proper form handling. string | null | |
| id | Sets id attribute for input. If left blank, it will default to the string | null | |
| placeholder | Sets the placeholder value. string | null | |
| label | Used to describe field in error message string | null | |
| disabled | Sets the disabled attribute. boolean | null | |
| required | Sets the field to required. boolean | false | |
| critical | Flags the field as critical. Critical is not required: a required field blocks saving, while a critical field saves fine empty but blocks something later, such as activating or completing a record. Use it for "you will need this before you can finish", not "you must enter this now". While the field is empty, the control takes the boolean | false | |
| locked | Locks the field: disables the control and marks it with a lock icon. Text-like controls show the
lock inside the input, in the spot a select keeps its arrow. Option groups, booleans and file
inputs have no box to put it in, so they show it beside the label of a surrounding boolean | false | |
| lockedMessage | Why the field is locked, for example "Locked while payroll is open". Shown as a tooltip when the
pointer rests on the locked control, and on the lock icon beside the label, which becomes
focusable so keyboard users can reach the text (the disabled control itself cannot take focus).
Rendered through en-components' string | "" | |
| typeCast | Used to specifically validate different types. string | "string" | |
| mode | Sets when and how often validation occurs. TODO: create docs for modes string | "eager" | |
| displayOnly | Displays the value of the field in a span element, instead of as an input. boolean | false | |
| emptyValue | What a boolean | string | false | |
| rules | A pipe separated string of validation rules for the field. View validation rules string | "" | |
| renderInForm | Prevents a field from being rendered at all when used in the boolean | function | true | |
| renderInTable | Prevents a field from generating a column/heading in the boolean | function | true | |
| customMessages | Provide a custom error messages by rule. Should be an object with keys that match the rule name and value being a string of the message to display. object | null | complex object |
| options | Array of option objects with label and value keys. array | unknown | complex object |
| valueKey | Sets a different key to use to retrieve the value from the options passed to the component. string | "value" | |
| labelKey | Sets a different key to use to retrieve the label from the options passed to the component. string | "label" | |
| labelColors | Sets default colors for option labels in displayOnly mode array | unknown | complex object |
| emptyOption | An entry for "nothing selected", prepended to the list. The prompt is presentation, not data: it exists so the control has an unselected state,
which is the component's business rather than the server's. Supplying it here keeps it out
of Pass object | string | null | |
| optionsKey | Sets a different key to use to retrieve the options from the option groups passed to the component. string | "options" |
Slots
display
No description
Variables
| Name | Type | Description |
|---|---|---|
selections | unknown | — |
Events
No events defined.
Methods
| Name | Description |
|---|---|
| focus | Focuses a button group input element. |
Examples
Small
small sizes the whole group down — the compact picker that sits inside a panel heading, where a full-height group would dominate the row. It applies en-style's btn-group-sm, so every button is sized without btn-sm repeated on each one.
Equal-width options
justifyButtons stretches the options to fill the row, so they end up the same width regardless of label length. Use it when the group is the full width of its column and uneven segments would read as accidental.
Related Components
- EnInputRadioGroup — The same choice as plain radios, pills, or bordered cards.
- Button modifiers — The underlying
btn-groupsizing.