Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListItemAddonProps

Hierarchy

  • Omit<TextIconSpacingProps, "icon" | "iconAfter" | "forceIconWrap">
    • ListItemAddonProps

Index

Properties

aboveClassName?: string

The class name to use for an icon that is placed before above the text. This is used when the stacked prop is enabled and the iconAfter prop is disabled or omitted.

addon: ReactNode | ReactElement<any, string | JSXElementConstructor<any>>

The addon that should be rendered.

addonAfter?: boolean

Boolean if the addon should appear after the children.

afterClassName?: string

The class name to use for an icon that is placed after text.

beforeClassName?: string

The class name to use for an icon that is placed before text.

belowClassName?: string

The class name to use for an icon that is placed before above the text. This is used when the stacked prop is enabled and the iconAfter prop is enabled.

children?: ReactNode

The children to render before or after the provided icon. This is defaulted to null so that providing a null icon will correctly render without React crashing.

className?: string

An optional className to apply to the surrounding <span> when the forceIconWrap prop is enabled or the icon is not a valid React Element. If the forceIconWrap prop is not enabled, it will be cloned into the icon instead.

flexReverse?: boolean

Boolean if the icon and content are in a column-reverse or row-reverse flex-direction. This will swap the different classnames as needed.

remarks

@since 2.5.0

forceAddonWrap?: boolean

Boolean if the addon should be forced into a <span> with the class names applied instead of attempting to clone into the provided icon. If the type is set to "media" or "large-media", this will default to true.

The vertical position to use for the addon.

stacked?: boolean

Boolean if the icon and text should be stacked instead of inline. Note: You'll normally want to update the container element to have display: flex and flex-direction: column for this to work.

The addon type that is used to adjust the spacing styles.

Generated using TypeDoc