Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoBoxComponentProperties

Properties for configuring a InfoBoxComponent

Hierarchy

Index

Properties

Optional CSSStyles

CSSStyles: CssStyles

Matches the CSS style key and its available values.

Optional announceText

announceText: boolean

Controls whether the text should be announced by the screen reader. Default value is false.

Optional ariaHidden

ariaHidden: boolean

Corresponds to the aria-hidden accessibility attribute for this component

Optional ariaLabel

ariaLabel: string

Corresponds to the aria-label accessibility attribute for this component

Optional ariaRole

ariaRole: string

Corresponds to the role accessibility attribute for this component

Optional ariaSelected

ariaSelected: boolean

Corresponds to the aria-selected accessibility attribute for this component

Optional display

display: DisplayType

Corresponds to the display CSS property for the element

Optional enabled

enabled: boolean

Whether the component is enabled in the DOM

Optional height

height: string | number

Optional position

position: PositionType

The position CSS property. Empty by default. This is particularly useful if laying out components inside a FlexContainer and the size of the component is meant to be a fixed size. In this case the position must be set to 'absolute', with the parent FlexContainer having 'relative' position. Without this the component will fail to correctly size itself

style

The style of the InfoBox

text

text: string

The display text of the InfoBox

Optional width

width: string | number

Generated using TypeDoc