feat: add as prop

Author: marsidev

docs/props.mdx

@@ -14,6 +14,11 @@ These are the props you can pass to the `Turnstile` component.
 | onSuccess     | `function` | Callback that is invoked upon success of the challenge. The callback is passed a token that can be validated.                                                                                                                                                                                                          |              |
 | onExpire      | `function` | Callback that is invoked when a challenge expires. Read the [Cloudflare docs](https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#refreshing-a-widget) for more info about handling expired widgets.                                                                                                   |              |
 | onError       | `function` | Callback that is invoked when there is a network error.                                                                                                                                                                                                                                                                |              |
+| as       | `string` | Define the HTML tag of the widget container. Default to `'div'`.                                                                                                                                                                                                                                                                |              |
+
+<Info>
+	You can pass any valid HTML prop such as `className`, `id`, or `style`, based on the `as` prop.
+</Info>
 
 ### `options` prop
 
@@ -36,9 +41,6 @@ These are the props you can pass to the `Turnstile` component.
 <Info>
   Read the [Cloudflare docs](https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#configurations) to get more info about this options.
 </Info>
-<Info>
-  The widget is wrapped in a `div`, so you can also pass any valid `div` prop such as `className`, `id`, or `style`.
-</Info>
 
 ### `scriptOptions` prop
 

packages/lib/src/container.tsx

@@ -0,0 +1,20 @@
+import type { ComponentPropsWithoutRef, ElementType, ForwardedRef } from 'react'
+import { forwardRef } from 'react'
+
+type Props<Tag extends ElementType> = {
+	as?: Tag
+} & ComponentPropsWithoutRef<Tag>
+
+type ComponentProps<Tag extends ElementType = 'div'> = Tag extends keyof JSX.IntrinsicElements
+	? Props<Tag>
+	: // eslint-disable-next-line @typescript-eslint/no-explicit-any
+	  Props<any>
+
+const Component = <Tag extends ElementType = 'div'>(
+	{ as: Element = 'div', ...props }: ComponentProps<Tag>,
+	ref: ForwardedRef<Element>
+) => {
+	return <Element {...props} ref={ref} />
+}
+
+export default forwardRef(Component)

packages/lib/src/lib.tsx

@@ -7,10 +7,21 @@ import {
 	injectTurnstileScript
 } from './utils'
 import { RenderOptions, TurnstileInstance, TurnstileProps } from './types'
+import Container from './container'
 
 export const Turnstile = forwardRef<TurnstileInstance | undefined, TurnstileProps>((props, ref) => {
-	const { scriptOptions, options, siteKey, onSuccess, onExpire, onError, id, style, ...divProps } =
-		props
+	const {
+		scriptOptions,
+		options,
+		siteKey,
+		onSuccess,
+		onExpire,
+		onError,
+		id,
+		style,
+		as = 'div',
+		...divProps
+	} = props
 	const config = options ?? {}
 	const widgetSize = config.size ?? 'normal'
 
@@ -19,7 +30,7 @@ export const Turnstile = forwardRef<TurnstileInstance | undefined, TurnstileProp
 		config.execution === 'execute' ? CONTAINER_STYLE_SET.invisible : CONTAINER_STYLE_SET[widgetSize]
 	)
 	const [scriptLoaded, setScriptLoaded] = useState(false)
-	const containerRef = useRef<HTMLDivElement | null>(null)
+	const containerRef = useRef<HTMLElement | null>(null)
 	const firstRendered = useRef(false)
 
 	const containerId = id ?? DEFAULT_CONTAINER_ID
@@ -205,8 +216,9 @@ export const Turnstile = forwardRef<TurnstileInstance | undefined, TurnstileProp
 	}, [widgetSize, config.execution])
 
 	return (
-		<div
+		<Container
 			ref={containerRef}
+			as={as}
 			id={containerId}
 			style={{ ...containerStyle, ...style }}
 			{...divProps}

packages/lib/src/types.d.ts

@@ -285,6 +285,11 @@ interface TurnstileProps extends React.HTMLAttributes<HTMLDivElement> {
 	 * Custom injected script options.
 	 */
 	scriptOptions?: ScriptOptions
+
+	/**
+	 * Define the HTML tag of the widget container. Default to `'div'`.
+	 */
+	as?: React.ElementType
 }
 
 interface InjectTurnstileScriptParams {