oc · docs
docs / documentation

@orangecheck/design


@orangecheck/design / HelpHintProps

Interface: HelpHintProps

Defined in: composites/help-hint.tsx:9

Properties

PropertyTypeDescriptionDefined in
<a id="property-children"></a> childrenReactNodeThe help body — short prose (1–3 sentences) explaining a term/control.composites/help-hint.tsx:11
<a id="property-classname"></a> className?string-composites/help-hint.tsx:23
<a id="property-label"></a> label?stringAccessible label for the trigger (defaults to "what is this?").composites/help-hint.tsx:22
<a id="property-side"></a> side?"top" | "right" | "bottom" | "left"Which side the popover prefers to open toward. Default top.composites/help-hint.tsx:15
<a id="property-size"></a> size?"sm" | "xs"xs tightens the icon for dense label rows; sm (default) suits most.composites/help-hint.tsx:17
<a id="property-title"></a> title?stringOptional bold "§ "-prefixed heading inside the popover.composites/help-hint.tsx:13
<a id="property-tone"></a> tone?"default" | "subtle"subtle mutes the "?" icon when it sits in a description / muted row; default is primary-tinted for active labels.composites/help-hint.tsx:20