fix(css): add JSDoc comment to sx.label

system-ui · Jun 10, 2021 · ce4129b · ce4129b
1 parent 6bf6cc5
commit ce4129b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/packages/color/test/index.tsx b/packages/color/test/index.tsx
@@ -6,8 +6,6 @@ import { ThemeProvider } from '@theme-ui/theme-provider'
 import { render } from '@theme-ui/test-utils'
 import { matchers } from '@emotion/jest'
 
-expect.extend(matchers)
-
 import {
   darken,
   lighten,
@@ -27,6 +25,8 @@ import {
   grayscale,
 } from '../src'
 
+expect.extend(matchers)
+
 const theme = {
   colors: {
     primary: '#0cf',

diff --git a/packages/css/src/types.ts b/packages/css/src/types.ts
@@ -491,7 +491,13 @@ export interface ThemeDerivedStyles {
   (theme: Theme): ThemeUICSSObject
 }
 
-export type Label = {
+export interface Label {
+  /**
+   * String appended to generated class name.
+   * @see https://emotion.sh/docs/labels
+   *
+   * You can style HTML <label> elements with `"& label": {}`.
+   */
   label?: string
 }