|
23 | 23 |
|
24 | 24 | ## Properties |
25 | 25 |
|
26 | | -| Property | Attribute | Description | Type | Default | |
27 | | -| ------------------------------- | ------------------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | |
28 | | -| `addClickHandle` | `add-click-handle` | Adds a click handler to the referenceElement to toggle open the Popover. | `boolean` | `false` | |
29 | | -| `closeButton` | `close-button` | Display a close button within the Popover. | `boolean` | `false` | |
30 | | -| `disableFlip` | `disable-flip` | Prevents flipping the popover's placement when it starts to overlap its reference element. | `boolean` | `false` | |
31 | | -| `disablePointer` | `disable-pointer` | Removes the caret pointer. | `boolean` | `false` | |
32 | | -| `flowInner` | `flow-inner` | Makes the popover flow toward the inner of the reference element. | `boolean` | `false` | |
33 | | -| `open` | `open` | Display and position the component. | `boolean` | `false` | |
34 | | -| `placement` | `placement` | Determines where the component will be positioned relative to the referenceElement. | `"auto-start" \| "auto" \| "auto-end" \| "top-start" \| "top" \| "top-end" \| "right-start" \| "right" \| "right-end" \| "bottom-end" \| "bottom" \| "bottom-start" \| "left-end" \| "left" \| "left-start" \| "leading-start" \| "leading" \| "leading-end" \| "trailing-end" \| "trailing" \| "trailing-start"` | `"auto"` | |
35 | | -| `referenceElement` _(required)_ | `reference-element` | Reference HTMLElement used to position this component according to the placement property. | `HTMLElement \| string` | `undefined` | |
36 | | -| `textClose` | `text-close` | Text for close button. | `string` | `"Close"` | |
37 | | -| `theme` | `theme` | Select theme (light or dark) | `"dark" \| "light"` | `"light"` | |
38 | | -| `xOffset` | `x-offset` | Offset the position of the popover in the horizontal direction. | `number` | `0` | |
39 | | -| `yOffset` | `y-offset` | Offset the position of the popover in the vertical direction. | `number` | `0` | |
| 26 | +| Property | Attribute | Description | Type | Default | |
| 27 | +| ------------------------------- | -------------------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | |
| 28 | +| `addClickHandle` | `add-click-handle` | Adds a click handler to the referenceElement to toggle open the Popover. | `boolean` | `false` | |
| 29 | +| `boundariesElement` | `boundaries-element` | HTMLElement Used to position this component within the a boundary. | `HTMLElement \| string` | `undefined` | |
| 30 | +| `closeButton` | `close-button` | Display a close button within the Popover. | `boolean` | `false` | |
| 31 | +| `disableFlip` | `disable-flip` | Prevents flipping the popover's placement when it starts to overlap its reference element. | `boolean` | `false` | |
| 32 | +| `disablePointer` | `disable-pointer` | Removes the caret pointer. | `boolean` | `false` | |
| 33 | +| `flipPlacements` | -- | Defines the available placements that can be used when a flip occurs. | `Position[]` | `undefined` | |
| 34 | +| `flowInner` | `flow-inner` | Makes the popover flow toward the inner of the reference element. | `boolean` | `false` | |
| 35 | +| `open` | `open` | Display and position the component. | `boolean` | `false` | |
| 36 | +| `placement` | `placement` | Determines where the component will be positioned relative to the referenceElement. | `"top" \| "right" \| "bottom" \| "left" \| "auto-start" \| "auto" \| "auto-end" \| "top-start" \| "top-end" \| "right-start" \| "right-end" \| "bottom-end" \| "bottom-start" \| "left-end" \| "left-start" \| "leading-start" \| "leading" \| "leading-end" \| "trailing-end" \| "trailing" \| "trailing-start"` | `"auto"` | |
| 37 | +| `referenceElement` _(required)_ | `reference-element` | Reference HTMLElement used to position this component according to the placement property. | `HTMLElement \| string` | `undefined` | |
| 38 | +| `textClose` | `text-close` | Text for close button. | `string` | `"Close"` | |
| 39 | +| `theme` | `theme` | Select theme (light or dark) | `"dark" \| "light"` | `"light"` | |
| 40 | +| `xOffset` | `x-offset` | Offset the position of the popover in the horizontal direction. | `number` | `0` | |
| 41 | +| `yOffset` | `y-offset` | Offset the position of the popover in the vertical direction. | `number` | `0` | |
40 | 42 |
|
41 | 43 |
|
42 | 44 | ## Methods |
|
0 commit comments