LogicButton

A LogicButton displays an operator within a boolean logic sequence.

installyarn add @adobe/react-spectrum
version3.3.0
usageimport {LogicButton} from '@adobe/react-spectrum'

Example#


<LogicButton variant="and">And</LogicButton>
<LogicButton variant="and">And</LogicButton>
<LogicButton variant="and">
  And
</LogicButton>

Content#


LogicButtons must have a variant and optionally can have a label. A visible label can be provided by passing children.

<LogicButton variant="or">Or</LogicButton>
<LogicButton variant="or">Or</LogicButton>
<LogicButton variant="or">
  Or
</LogicButton>

Internationalization#

In order to internationalize a LogicButton, a localized string should be passed to the children or aria-label prop.

Events#


LogicButton supports user interactions via mouse, keyboard, and touch. You can handle all of these via the onPress prop.

The following example uses an onPress handler to update the variant.

function Example() {
  let [variant, setVariant] = React.useState('Or');

  return (
    <LogicButton
      variant={variant.toLowerCase()}
      onPress={() => setVariant(variant === 'Or' ? 'And' : 'Or')}>
      {variant}
    </LogicButton>
  );
}
function Example() {
  let [variant, setVariant] = React.useState('Or');

  return (
    <LogicButton
      variant={variant.toLowerCase()}
      onPress={() =>
        setVariant(variant === 'Or' ? 'And' : 'Or')
      }>
      {variant}
    </LogicButton>
  );
}
function Example() {
  let [
    variant,
    setVariant
  ] = React.useState(
    'Or'
  );

  return (
    <LogicButton
      variant={variant.toLowerCase()}
      onPress={() =>
        setVariant(
          variant ===
            'Or'
            ? 'And'
            : 'Or'
        )
      }>
      {variant}
    </LogicButton>
  );
}

Props#


NameTypeDefaultDescription
variant'and''or'The type of boolean sequence to be represented by the LogicButton.
type'button''submit''reset''button'The behavior of the button when used in an HTML form.
isDisabledbooleanWhether the button is disabled.
childrenReactNodeThe content to display in the button.
autoFocusbooleanWhether the element should receive focus on render.
Events
NameTypeDefaultDescription
onPress( (e: PressEvent )) => voidHandler that is called when the press is released over the target.
onPressStart( (e: PressEvent )) => voidHandler that is called when a press interaction starts.
onPressEnd( (e: PressEvent )) => voidHandler that is called when a press interaction ends, either over the target or when the pointer leaves the target.
onPressChange( (isPressed: boolean )) => voidHandler that is called when the press state changes.
onPressUp( (e: PressEvent )) => voidHandler that is called when a press is released over the target, regardless of whether it started on the target or not.
onFocus( (e: FocusEvent )) => voidHandler that is called when the element receives focus.
onBlur( (e: FocusEvent )) => voidHandler that is called when the element loses focus.
onFocusChange( (isFocused: boolean )) => voidHandler that is called when the element's focus status changes.
onKeyDown( (e: KeyboardEvent )) => voidHandler that is called when a key is pressed.
onKeyUp( (e: KeyboardEvent )) => voidHandler that is called when a key is released.
Layout
NameTypeDefaultDescription
flexstringnumberbooleanWhen used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrownumberWhen used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinknumberWhen used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisnumberstringWhen used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelf'auto''normal''start''end''center''flex-start''flex-end''self-start''self-end''stretch'Overrides the alignItems property of a flex or grid container. See MDN.
justifySelf'auto''normal''start''end''flex-start''flex-end''self-start''self-end''center''left''right''stretch'Specifies how the element is justified inside a flex or grid container. See MDN.
ordernumberThe layout order for the element within a flex or grid container. See MDN.
gridAreastringWhen used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnstringWhen used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowstringWhen used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartstringWhen used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndstringWhen used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartstringWhen used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndstringWhen used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginDimensionValueThe margin for all four sides of the element. See MDN.
marginTopDimensionValueThe margin for the top side of the element. See MDN.
marginBottomDimensionValueThe margin for the bottom side of the element. See MDN.
marginStartDimensionValueThe margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndDimensionValueThe margin for the logical end side of an element, depending on layout direction. See MDN.
marginXDimensionValueThe margin for both the left and right sides of the element. See MDN.
marginYDimensionValueThe margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthDimensionValueThe width of the element. See MDN.
minWidthDimensionValueThe minimum width of the element. See MDN.
maxWidthDimensionValueThe maximum width of the element. See MDN.
heightDimensionValueThe height of the element. See MDN.
minHeightDimensionValueThe minimum height of the element. See MDN.
maxHeightDimensionValueThe maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
position'static''relative''absolute''fixed''sticky'Specifies how the element is positioned. See MDN.
topDimensionValueThe top position for the element. See MDN.
bottomDimensionValueThe bottom position for the element. See MDN.
leftDimensionValueThe left position for the element. See MDN. Consider using start instead for RTL support.
rightDimensionValueThe right position for the element. See MDN. Consider using start instead for RTL support.
startDimensionValueThe logical start position for the element, depending on layout direction. See MDN.
endDimensionValueThe logical end position for the element, depending on layout direction. See MDN.
zIndexnumberThe stacking order for the element. See MDN.
isHiddenbooleanHides the element.
Accessibility
NameTypeDefaultDescription
idstringThe element's unique identifier. See MDN.
excludeFromTabOrderbooleanWhether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
aria-expandedbooleanIndicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-haspopupboolean'menu''listbox''tree''grid''dialog'Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-controlsstringIdentifies the element (or elements) whose contents or presence are controlled by the current element.
aria-pressedbooleanIndicates the current "pressed" state of toggle buttons.
aria-labelstringDefines a string value that labels the current element.
aria-labelledbystringIdentifies the element (or elements) that labels the current element.
aria-describedbystringIdentifies the element (or elements) that describes the object.
aria-detailsstringIdentifies the element (or elements) that provide a detailed, extended description for the object.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestringSets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSPropertiesSets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#


Variant#

<LogicButton variant="or" marginEnd="20px">
  Or
</LogicButton>
<LogicButton variant="and">And</LogicButton>
<LogicButton variant="or" marginEnd="20px">
  Or
</LogicButton>
<LogicButton variant="and">And</LogicButton>
<LogicButton
  variant="or"
  marginEnd="20px">
  Or
</LogicButton>
<LogicButton variant="and">
  And
</LogicButton>

Disabled#

<LogicButton variant="or" isDisabled>
  Or
</LogicButton>
<LogicButton variant="or" isDisabled>
  Or
</LogicButton>
<LogicButton
  variant="or"
  isDisabled>
  Or
</LogicButton>