@wix/design-system
Version:
@wix/design-system
109 lines (106 loc) • 3.49 kB
Markdown
### className
- type: string
- description: No description
### id
- type: string
- description: Applies id HTML attribute.
### children
- type: ReactNode
- description: Renders any kind of content within a heading. Usually it’s a text string.
### onClick
- type: MouseEventHandler
- description: No description
### disabled
- type: boolean
- description: No description
### ellipsis
- type: boolean
- description: When true, text that is longer than it's container will be truncated to a single line followed by ellipsis. Otherwise the text will break into several lines.
### textAlign
- type: "center" | "start"
- description: No description
### enterDelay
- type: number
- description: No description
### exitDelay
- type: number
- description: No description
### moveBy
- type: Partial<{ x: number; y: number; }>
- description: No description
### moveArrowTo
- type: number
- description: No description
### appendTo
- type: null | Element | "window" | "viewport" | "scrollParent" | "parent" | Predicate
- description: No description
### flip
- type: boolean
- description: No description
### fixed
- type: boolean
- description: No description
### maxWidth
- type: string | number | string & {}
- description: No description
### onShow
- type: () => void
- description: No description
### onHide
- type: () => void
- description: No description
### placement
- type: "right" | "left" | "auto" | "auto-start" | "auto-end" | "top-start" | "top" | "top-end" | "right-start" | "right-end" | "bottom-end" | "bottom" | "bottom-start" | "left-end" | "left-start"
- description: No description
### zIndex
- type: string & {} | "-moz-initial" | "inherit" | "initial" | "revert" | "revert-layer" | "unset" | "auto" | number & {}
- description: No description
### interactive
- type: boolean
- description: No description
### showTooltip
- type: boolean
- description: True by default, set it to false in order to show ellipsis without a tooltip.
### maxLines
- type: number
- description: maxLines truncates text at a specific number of lines.
### onEllipsisStateChange
- type: (isActive: boolean) => void
- description: A callback fired when ellipsis state changes.
### dataHook
- type: string
- description: Applies a data-hook HTML attribute that can be used in the tests.
### tagName
- type: string
- description: Defines a tag name that text should be rendered inside of (e.g., div, a, p).
### size
- type: "tiny" | "small" | "medium"
- description: Controls the font size of the text.
### secondary
- type: boolean
- description: Sets text type to secondary. Affects font color only.
### skin
- type: "standard" | "disabled" | "error" | "premium" | "primary" | "success"
- description: Controls the skin of the text.
### light
- type: boolean
- description: Inverts text color so it can be used on dark backgrounds.
### weight
- type: "bold" | "normal" | "thin"
- description: Controls the font weight of the text.
### listStyle
- type: "circle" | "checkmark"
- description: Sets list items style.
### tooltipProps
- type: TooltipCommonProps
- description: Allows to pass all common tooltip props.
### widows
- type: boolean
- description: if true it will support widows in the text
### suffix
- type: ReactNode
- description: Component displayed at the end of text, after ellipsis if truncated.
- internal
### overflowWrap
- type: "normal" | "break-word" | "anywhere"
- description: Sets "overflow-wrap" CSS property. Controls how text will behave upon overflowing parent component