@react-hive/honey-style 6.2.0 → 7.0.0

package/dist/index.dev.cjs

@@ -1921,6 +1921,60 @@ __webpack_require__.r(__webpack_exports__);
 
 
 
+/**
+ * Creates a Honey-styled component from an HTML element or React component.
+ *
+ * The returned function accepts a tagged template literal with static CSS and dynamic
+ * interpolations. Interpolations receive the resolved styled context, including the
+ * current theme, default props, and props passed to the component.
+ *
+ * The generated component supports the polymorphic `as` prop, so the rendered element
+ * can be changed while preserving the native props of the selected element.
+ *
+ * Default props can be provided as either an object or a resolver function. Props passed
+ * directly to the rendered styled component override default props.
+ *
+ * @template TargetProps - The custom props available to style interpolations.
+ * @template Target - The base HTML element or React component used for rendering.
+ * @template OverrideTarget - The default polymorphic element used for public prop inference.
+ *
+ * @param target - The base HTML element or React component to style.
+ * @param defaultProps - Optional default props or a function that resolves default props from context.
+ * @param options - Optional styled component options.
+ *
+ * @returns A tagged template function that creates a styled component.
+ *
+ * @example
+ * ```tsx
+ * const Box = styled('div')`
+ *   color: red;
+ * `;
+ *
+ * <Box data-testid="box">Content</Box>
+ * ```
+ *
+ * @example
+ * ```tsx
+ * const Button = styled<{ variant: 'primary' | 'secondary' }, 'button'>('button')`
+ *   ${({ variant }) => css`
+ *     color: ${variant === 'primary' ? 'white' : 'black'};
+ *   `}
+ * `;
+ *
+ * <Button variant="primary" type="button" />
+ * ```
+ *
+ * @example
+ * ```tsx
+ * const LinkBox = styled('div')`
+ *   color: blue;
+ * `;
+ *
+ * <LinkBox as="a" href="https://example.com">
+ *   Link
+ * </LinkBox>
+ * ```
+ */
 const styled = (target, defaultProps, { omitProps } = {}) => {
     return (strings, ...interpolations) => {
         const componentId = (0,_utils__WEBPACK_IMPORTED_MODULE_4__.generateId)('hsc');