From 92dfba19b9cb064a0adba599a750de5660adddc3 Mon Sep 17 00:00:00 2001 From: mainframev Date: Fri, 13 Dec 2024 15:04:16 +0100 Subject: [PATCH] docs(react-keytips): update docs --- packages/react-keytips/src/docs/MIGRATION.md | 6 ++++-- packages/react-keytips/src/docs/Spec.md | 2 ++ packages/react-keytips/stories/OverflowMenu.md | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/packages/react-keytips/src/docs/MIGRATION.md b/packages/react-keytips/src/docs/MIGRATION.md index a9ea4495..f79cd1e6 100644 --- a/packages/react-keytips/src/docs/MIGRATION.md +++ b/packages/react-keytips/src/docs/MIGRATION.md @@ -20,8 +20,10 @@ This Migration guide is a work in progress and is not yet ready for use. - `useKeytipRef`: - `offset` - Changed. Instead use [positioning.offset](https://react.fluentui.dev/?path=/docs/concepts-developer-positioning-components--docs#offset-value). - `styles` - Not supported. - - `theme` - Not supported. + - `theme` - Not supported. `Keytip` theme depends on the values passed to `css` variables. - `disabled` - Not supported. `Keytip` won't appear for disabled target. `callOutProps` -> Not supported. Instead there are multiple props available, that has to be used individually: `positioning`, `visible`, `content`. - - `hasDynamicChildren` and `hasMenu` - merged into `dynamic` prop. If `Keytip` triggers dynamic content: Menu, Modal, Tabs or any other item that + - `hasDynamicChildren` became `dynamic` prop. If `Keytip` triggers dynamic content: Menu, Modal, Tabs or any other item that that has keytips, set `dynamic` to `true`. + - `overflowSetSequence` - Not supported. + - `hasOverflowSubMenu` -> Changed. Instead use `hasMenu`. diff --git a/packages/react-keytips/src/docs/Spec.md b/packages/react-keytips/src/docs/Spec.md index e0ff1761..c2b0c80f 100644 --- a/packages/react-keytips/src/docs/Spec.md +++ b/packages/react-keytips/src/docs/Spec.md @@ -135,6 +135,8 @@ The keytip is positioned below and centered to the target element by default. | `dynamic` | `boolean` | | Whether or not this keytip will have dynamic content: children keytips that are dynamically created (DOM is generated on keytip activation), Menu, Tabs or Modal. | | `visible` | `boolean` | `false` | Control the Keytip's visibility programmatically. | | `content` | `string` | | The text content of the Keytip. | +| `isShortcut` | `boolean` | `false` | Registers keytip as a shortcut, will try to invoke the full sequence until it will reach the target keytip. | +| `hasMenu` | `boolean` | `false` | Whether or not this keytip belongs to a component that has a menu Keytip mode will stay on when a menu is opened, even if the items in that menu have no keytips. | ## Structure diff --git a/packages/react-keytips/stories/OverflowMenu.md b/packages/react-keytips/stories/OverflowMenu.md index 7c5ebb39..1595b5eb 100644 --- a/packages/react-keytips/stories/OverflowMenu.md +++ b/packages/react-keytips/stories/OverflowMenu.md @@ -1,4 +1,4 @@ -Keytips with `Overflow` and `Menu` components offer special options, that can be used: +Keytips with `Overflow` and `Menu` components offer special options: `isShortcut` - a Keytip can be a shortcut, that can be accessed from the top overflow level. A shortcut to a normal Button will trigger it immediately, if it's attached to a Menu, it will open a Menu, even if Keytip does not have a child Keytip to show.