@sanity/ui 5.0.0-alpha.7 → 5.0.0-alpha.9

package/src/components/skip-to-content/skipToContent.props.ts

@@ -3,12 +3,18 @@ import {type PropDef} from '../../types/PropDef'
 /** @beta */
 export interface SkipToContentProps extends React.ComponentProps<'a'> {
   /**
-   * Anchor href. The target element should be focusable or have `tabindex="-1"`.
+   * Same-page fragment to jump to.
+   * @remarks Note: The hash character # is required for proper linking.
    */
   href: string
-  /** Visible/announced label */
+  /**
+   * Visible and announced text.
+   */
   label: string
-  /** Use label instead */
+  /**
+   * Not accepted.
+   * @remarks Pass text via `label`.
+   */
   children?: never
 }
 

package/src/components/spinner/Spinner.tsx

@@ -1,4 +1,4 @@
-import {SpinnerIcon} from '@sanity/icons'
+import {SpinnerIcon} from '@sanity/icons/Spinner'
 import clsx from 'clsx'
 
 import {getProps} from '../../utils/getProps'

package/src/components/spinner/spinner.props.ts

@@ -4,6 +4,9 @@ import type {Responsive} from '../../types/Responsive'
 
 /** @public */
 export interface SpinnerProps extends React.ComponentProps<'svg'> {
+  /**
+   * Size of the spinner icon.
+   */
   size?: Responsive<IconSize>
 }
 

package/src/components/switch/switch.props.ts

@@ -3,9 +3,14 @@ import {type PropDef} from '../../types/PropDef'
 
 /** @beta */
 export interface SwitchProps extends React.ComponentProps<'input'>, MarginProps {
-  /** Error state */
+  /**
+   * Applies error styling to the switch track.
+   * @remarks Use when form validation fails. Pair with a visible error message. The prop is visual only.
+   */
   error?: boolean
-  /** Input label */
+  /**
+   * Visible label next to the switch.
+   */
   label: React.ReactNode
 }
 

package/src/components/text/text.props.ts

@@ -5,9 +5,13 @@ import {TEXT_SIZE, type TextSize} from '../../types/Text'
 
 /** @public */
 export interface TextProps<T extends React.ElementType = 'span'> extends TypographyProps {
-  /** Element to render */
+  /**
+   * HTML element to render.
+   */
   as?: T
-  /** CSS **font-size** property */
+  /**
+   * Sets font size.
+   */
   size?: Responsive<TextSize>
 }
 

package/src/components/tooltip/tooltip.props.ts

@@ -4,13 +4,21 @@ import {type PropDef} from '../../types/PropDef'
 /** @beta */
 export interface TooltipProps
   extends Omit<React.ComponentProps<'div'>, 'children' | 'content'>, PlacementProps {
-  /** Anchor name for positioning */
+  /**
+   * Shared anchor identifier.
+   */
   anchorName?: React.ReactNode
-  /** Focusable trigger element */
+  /**
+   * The trigger element.
+   */
   children: React.ReactElement<Record<string, unknown>>
-  /** Tooltip content */
+  /**
+   * The tooltip label.
+   */
   content?: React.ReactNode
-  /** Render tooltip in portal */
+  /**
+   * Renders the label into `document.body` through a React portal instead of inline.
+   */
   portal?: boolean
 }
 

package/src/components/tooltip-group/tooltipGroup.props.ts

@@ -2,7 +2,9 @@ import {type PropDef} from '../../types/PropDef'
 
 /** @public */
 export interface TooltipGroupProps<T extends React.ElementType = 'div'> {
-  /** Element to render */
+  /**
+   * HTML element to render.
+   */
   as?: T
 }
 

package/src/components/v-stack/vStack.props.ts

@@ -3,7 +3,9 @@ import {type PropDef} from '../../types/PropDef'
 
 /** @public */
 export interface VStackProps<T extends React.ElementType = 'div'> extends Pick<GapProps, 'gap'> {
-  /** Element to render */
+  /**
+   * HTML element or component to render.
+   */
   as?: T
 }
 

package/src/components/visually-hidden/visuallyHidden.props.ts

@@ -2,9 +2,13 @@ import {type PropDef} from '../../types/PropDef'
 
 /** @public */
 export interface VisuallyHiddenProps<T extends React.ElementType = 'span'> {
-  /** Element to render */
+  /**
+   * HTML element to render.
+   */
   as?: T
-  /** If true, element is visible on :focus-visible */
+  /**
+   * If true, the element becomes visible on `:focus-visible`.
+   */
   visibleOnFocus?: boolean
 }
 

package/src/index.ts

@@ -62,3 +62,4 @@ export type {TextSize} from './types/Text'
 export type {TextAlign} from './types/TextAlign'
 export type {FontWeight} from './types/FontWeight'
 export type {Tone} from './types/Tone'
+export * from './components/badge/Badge'

package/src/version.ts

@@ -1,3 +1,3 @@
 // This file is generated by scripts/write-version.js. Do not edit.
-export const VERSION = '500alpha7'
-export const HASH = '47d232'
+export const VERSION = '500alpha9'
+export const HASH = 'fd663f'