From 15d2880d3ab6be6c6ffa44baec2739c2cb248154 Mon Sep 17 00:00:00 2001 From: aidendk Date: Wed, 8 Jun 2022 16:47:50 -0500 Subject: [PATCH] tooltip spec update - to be proofread (#309) --- .../src/tooltip/tooltip.spec.md | 24 +++++++++++++------ 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/packages/nimble-components/src/tooltip/tooltip.spec.md b/packages/nimble-components/src/tooltip/tooltip.spec.md index 36ee9a7f62..f1f77551bd 100644 --- a/packages/nimble-components/src/tooltip/tooltip.spec.md +++ b/packages/nimble-components/src/tooltip/tooltip.spec.md @@ -6,6 +6,8 @@ The `nimble-tooltip` is a popup that displays information related to an element ### Background +[Nimble issue #309: Tooltip](https://github.com/ni/nimble/issues/309) + [Visual desgin spec](https://xd.adobe.com/view/8ce280ab-1559-4961-945c-182955c7780b-d9b1/screen/044414d7-1714-40f2-9679-2ce2c8202d1c/specs/) --- @@ -14,7 +16,10 @@ The `nimble-tooltip` is a popup that displays information related to an element ### API -[FAST tooltip API](https://github.com/microsoft/fast/blob/master/packages/web-components/fast-foundation/src/tooltip/tooltip.spec.md) +Plan to extend API to support all cases shown in visual design XD document. Will add +once tooltip is sucessfully implemented with one case. + +[FAST tooltip API](https://github.com/microsoft/fast/blob/de7f234ef871204fcac2b5df59433d919809341d/packages/web-components/fast-foundation/src/tooltip/tooltip.spec.md) *Provide a brief summary of the API below. For each section:* *If exposing FAST's API without changes, you can just write "Unchanged".* @@ -26,18 +31,15 @@ The `nimble-tooltip` is a popup that displays information related to an element - _Events:_ Unchanged - _CSS Classes and Custom Properties that affect the component:_ ? - _Slots:_ Unchanged -- _Template:_ ? - -[FAST Component tooltip](https://explore.fast.design/components/fast-tooltip) -Is design similar enough or does need styling changes? +- _Template:_ Unchanged ### Angular integration -*Describe the plan for Angular support, including directives for attribute binding and ControlValueAccessor for form integration.* +An Angular directive will be created for the component. The component will not have form association, so a `ControlValueAccessor` will not be created. ### Blazor integration -*Describe the plan for Blazor support. See the [nimble-blazor CONTRIBUTING.md](/packages/nimble-blazor/CONTRIBUTING.md) for details.* +A Blazor wrapper will be created for the component. ### Additional requirements @@ -45,13 +47,21 @@ Is design similar enough or does need styling changes? - *User interaction: Do the FAST component's behaviors match the visual design spec? When they differ, which approach is preferable and why?* - *Styling: Does FAST provide APIs to achieve the styling in the visual design spec?* + FAST API most likely won't be sufficient for creating extra states in spec, will be adressed later on. - *Testing: Is FAST's coverage sufficient? Should we write any tests beyond Chromatic visual tests?* + Will look at options as building, testing may be difficult because only displayed on hover. - *Documentation: Any requirements besides standard Storybook docs and updating the Example Client App demo?* + No additional requirements - *Tooling: Any new tools, updates to tools, code generation, etc?* + No additional requirements - *Accessibility: keyboard navigation/focus, form input, use with assistive technology, etc.* + - All accessibility needs should be covered by FAST's implementation. We should do some manual testing to verify that the custom template doesn't break any accessibility behavior. - *Globalization: special RTL handling, swapping of icons/visuals, localization, etc.* + No additional requirements - *Performance: does the FAST component meet Nimble's performance requirements?* + No additional requirements - *Security: Any requirements for security?* + No additional requirements ---