Skip to content

Commit 1a8e01e

Browse files
spark33spark33
authored
README formatting fix (#2148)
1 parent 1202b06 commit 1a8e01e

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

‎packages/popover/README.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -59,22 +59,22 @@ The popover component will be automatically positioned relative to its nearest p
5959

6060
## Properties
6161

62-
| Prop | Type | Description | Default |
63-
| ------------------ | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | --- |
64-
| `active` | `boolean` | Determines whether the Popover is active or inactive | `false` |
65-
| `align` | `'top'` \| `'bottom'` \| `'left'` \| `'right'` \| `'center-horizontal'` \| `'center-vertical'` | A string that determines the alignment of the popover relative to the `refEl`. | `'bottom'` |
66-
| `justify` | `'start'` \| `'middle'` \| `'end'` \| `'fit'` | A string that determines the justification of the popover relative to the `refEl`. Justification will be defined relative to the `align` prop | `'start'` |
67-
| `children` | `node` | Content that will appear inside of the `<Popver />` component | |
68-
| `spacing` | `number` | Specifies the amount of spacing (in pixels) between the trigger element and the content element. | `10` |
69-
| `className` | `string` | Classname to apply to popover-content container | |
70-
| `adjustOnMutation` | `boolean` | Should the Popover auto adjust its content when the DOM changes (using MutationObserver). | `false` |
71-
| `onClick` | `function` | Function that will be called when popover content is clicked. | |
72-
| `usePortal` | `boolean` | Will position Popover's children relative to its parent without using a Portal, if `usePortal` is set to false. NOTE: The parent element should be CSS position `relative`, `fixed`, or `absolute` if using this option. | `true` |
73-
| `portalContainer` | `HTMLElement` \| `null` | Sets the container used for the popover's portal. NOTE: If using a `scrollContainer` make sure that the `portalContainer` is contained within the `scrollContainer`. E.g, passing the same refrence to `scrollContainer` and `portalContainer`. | |
74-
| `scrollContainer` | `HTMLElement` \| `null` | If the popover portal has a scrollable ancestor other than the window, this prop allows passing a reference to that element to allow the portal to position properly. | |
75-
| `portalClassName` | `string` | Passes the given className to the popover's portal container if the default portal container is being used. | |
76-
| `popoverZIndex` | `number` | Sets the z-index CSS property for the popover. | | |
77-
| ... | native attributes of Portal or Fragment | Any other properties will be spread on the popover-content container | |
62+
| Prop | Type | Description | Default |
63+
| ------------------ | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- |
64+
| `active` | `boolean` | Determines whether the Popover is active or inactive | `false` |
65+
| `align` | `'top'` \| `'bottom'` \| `'left'` \| `'right'` \| `'center-horizontal'` \| `'center-vertical'` | A string that determines the alignment of the popover relative to the `refEl`. | `'bottom'` |
66+
| `justify` | `'start'` \| `'middle'` \| `'end'` \| `'fit'` | A string that determines the justification of the popover relative to the `refEl`. Justification will be defined relative to the `align` prop | `'start'` |
67+
| `children` | `node` | Content that will appear inside of the `<Popover />` component | |
68+
| `spacing` | `number` | Specifies the amount of spacing (in pixels) between the trigger element and the content element. | `10` |
69+
| `className` | `string` | Classname to apply to popover-content container | |
70+
| `adjustOnMutation` | `boolean` | Should the Popover auto adjust its content when the DOM changes (using MutationObserver). | `false` |
71+
| `onClick` | `function` | Function that will be called when popover content is clicked. | |
72+
| `usePortal` | `boolean` | Will position Popover's children relative to its parent without using a Portal, if `usePortal` is set to false. NOTE: The parent element should be CSS position `relative`, `fixed`, or `absolute` if using this option. | `true` |
73+
| `portalContainer` | `HTMLElement` \| `null` | Sets the container used for the popover's portal. NOTE: If using a `scrollContainer` make sure that the `portalContainer` is contained within the `scrollContainer`. E.g, passing the same reference to `scrollContainer` and `portalContainer`. | |
74+
| `scrollContainer` | `HTMLElement` \| `null` | If the popover portal has a scrollable ancestor other than the window, this prop allows passing a reference to that element to allow the portal to position properly. | |
75+
| `portalClassName` | `string` | Passes the given className to the popover's portal container if the default portal container is being used. | |
76+
| `popoverZIndex` | `number` | Sets the z-index CSS property for the popover. | |
77+
| ... | native attributes of Portal or Fragment | Any other properties will be spread on the popover-content container | |
7878

7979
## Advanced Use Case
8080

0 commit comments

Comments
 (0)