diff --git a/packages/@react-spectrum/s2/src/pressScale.ts b/packages/@react-spectrum/s2/src/pressScale.ts index d3110fcac18..d333e528f00 100644 --- a/packages/@react-spectrum/s2/src/pressScale.ts +++ b/packages/@react-spectrum/s2/src/pressScale.ts @@ -13,6 +13,28 @@ import {composeRenderProps} from 'react-aria-components/composeRenderProps'; import {CSSProperties, RefObject} from 'react'; +/** + * Returns a render prop style function that applies a subtle Spectrum "press" scale + * effect to an element while it is being pressed. + * + * @param ref - A ref to the element receiving the press effect. + * @param style - An optional base style object, or a render prop function returning + * one. + * @returns A render prop function suitable for passing to a React Aria component's + * `style` prop. + * + * @example + * ```tsx + * import {Button} from 'react-aria-components/Button'; + * import {pressScale} from '@react-spectrum/s2'; + * import {useRef} from 'react'; + * + * function MyButton(props) { + * let ref = useRef(null); + * return