@leafygreen-ui/inline-definition
v9.1.4
Published
leafyGreen UI Kit Inline Definition
Keywords
Readme
Inline Definition
View on MongoDB.design
Installation
PNPM
pnpm add @leafygreen-ui/inline-definitionYarn
yarn add @leafygreen-ui/inline-definitionNPM
npm install @leafygreen-ui/inline-definitionExample
<H2>
<InlineDefinition definition={shardDefinition}>Shard</InlineDefinition> your
cluster
</H2>Properties
| Prop | Type | Description | Default |
| ----------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | --------- |
| definition (Required) | React.ReactNode | Content that describes the term. Will appear inside Tooltip. | |
| children | string | Text that will appear underlined | |
| className | string | className will be applied to the trigger element | |
| align | 'top', 'bottom', 'left', 'right' | Determines the preferred alignment of the tooltip relative to the component's children. | 'top' |
| justify | 'start', 'middle', 'end' | Determines the preferred justification of the tooltip (based on the alignment) relative to the element passed to the component's children. | 'start' |
| darkMode | boolean | Determines if the component will appear in dark mode. | false |
| tooltipClassName | string | className to be applied to the tooltip element | |