Environment Information
- Package version(s): @uifabric/fabric-website@6.8.0
- Browser and OS versions: N/A
Please provide a reproduction of the bug in a codepen:
The docs can be seen on both the live Fabric site: https://developer.microsoft.com/en-us/fabric#/components/teachingbubble
And on the dev site (here at the 6.106.3 snap): https://fabricweb.z5.web.core.windows.net/oufr/6.106.3/#/examples/teachingbubble
Actual behavior:
The usage docs for TeachingBubble are essentially absent, and don't help consumers differentiate it from similar components like Callout, Tooltip, or Coachmark. The TeachingBubble is a very specific kind of Callout that is meant to be used in tandem with a Coachmark, to call attention to a part of a page. It was specifically designed to educate users about new features, and shouldn't be thought of as a helper for assistive text.
This can lead to cases where the control is used in contexts that it wasn't designed for, and where another control may be more appropriate.
Expected behavior:
The usage docs for TeachingBubble should be expanded, and should likely borrow from Coachmark to differentiate its use case.
Priorities and help requested:
Are you willing to submit a PR to fix? Yes
Requested priority: Normal
Products/sites affected: N/A
Environment Information
Please provide a reproduction of the bug in a codepen:
The docs can be seen on both the live Fabric site: https://developer.microsoft.com/en-us/fabric#/components/teachingbubble
And on the dev site (here at the 6.106.3 snap): https://fabricweb.z5.web.core.windows.net/oufr/6.106.3/#/examples/teachingbubble
Actual behavior:
The usage docs for TeachingBubble are essentially absent, and don't help consumers differentiate it from similar components like Callout, Tooltip, or Coachmark. The TeachingBubble is a very specific kind of Callout that is meant to be used in tandem with a Coachmark, to call attention to a part of a page. It was specifically designed to educate users about new features, and shouldn't be thought of as a helper for assistive text.
This can lead to cases where the control is used in contexts that it wasn't designed for, and where another control may be more appropriate.
Expected behavior:
The usage docs for TeachingBubble should be expanded, and should likely borrow from Coachmark to differentiate its use case.
Priorities and help requested:
Are you willing to submit a PR to fix? Yes
Requested priority: Normal
Products/sites affected: N/A