@wix/design-system
Version:
@wix/design-system
86 lines (83 loc) • 3.89 kB
Markdown
### dataHook
- type: string
- description: Applies a data-hook HTML attribute that can be used in the tests.
### className
- type: string
- description: Specifies a CSS class name to be appended to the component’s root element.
- internal
### light
- type: boolean
- description: Invert heading style so it can be used on a dark or image background.
### appearance
- type: "H1" | "H2" | "H3" | "H4" | "H5" | "H6"
- description: this prop is deprecated and should not be used
- deprecated
### as
- type: "object" | "small" | "title" | "button" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "input" | "ins" | "kbd" | "label" | "legend" | "li" | "link" | "main" | "map" | "mark" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "picture" | "pre" | "progress" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "search" | "section" | "select" | "slot" | "source" | "span" | "strong" | "style" | "sub" | "summary" | "sup" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr"
- description: Renders the heading as any other given HTML tag
### size
- type: "tiny" | "small" | "medium" | "large" | "extraLarge" | "extraTiny"
- description: Controls the heading's visual size and HTML tag appearance. HTML tag can be overridden with ‘as’ prop.
### id
- type: string
- description: Identifies the element that labels or describes the text element
### children
- type: ReactNode
- description: Renders any kind of content within a heading. Usually it’s a text string.
### 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.