docs(tooltip): add additional note for missing tooltip props

carbon-design-system · Dec 16, 2020 · 60bacd3 · 60bacd3
1 parent 81aa04f
commit 60bacd3
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packages/react/src/components/Tooltip/Tooltip.mdx b/packages/react/src/components/Tooltip/Tooltip.mdx
@@ -14,6 +14,11 @@ import { Props } from '@storybook/addon-docs/blocks';
 
 ## Component API
 
+Please note that in addition to the props below, `Tooltip` also has two
+additional props: `triggerText` and `iconDescription`. If the `triggerText` prop
+is _not_ provided, the `iconDescription` prop is required to populate the
+`aria-label` property for a11y reasons.
+
 <Props />
 
 ## Feedback