@clerk/types 4.70.1 → 4.71.0-snapshot.v20250728160410

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -5513,11 +5513,27 @@ type Variables = {
5513
5513
  type BaseThemeTaggedType = {
5514
5514
  __type: 'prebuilt_appearance';
5515
5515
  };
5516
- type BaseTheme = BaseThemeTaggedType & {
5516
+ type BaseTheme = (BaseThemeTaggedType | 'clerk' | 'simple') & {
5517
5517
  cssLayerName?: string;
5518
5518
  };
5519
5519
  type Theme = {
5520
5520
  /**
5521
+ * A theme used as the base theme for the components.
5522
+ * For further customisation, you can use the {@link Theme.layout}, {@link Theme.variables} and {@link Theme.elements} props.
5523
+ *
5524
+ * Supports both object-based themes and string-based themes:
5525
+ * @example
5526
+ * import { dark } from "@clerk/themes";
5527
+ * appearance={{ theme: dark }}
5528
+ *
5529
+ * @example
5530
+ * // Use string-based theme
5531
+ * appearance={{ theme: 'clerk' }}
5532
+ * appearance={{ theme: 'simple' }}
5533
+ */
5534
+ theme?: BaseTheme | BaseTheme[];
5535
+ /**
5536
+ * @deprecated Use `theme` instead. This property will be removed in a future version.
5521
5537
  * A theme used as the base theme for the components.
5522
5538
  * For further customisation, you can use the {@link Theme.layout}, {@link Theme.variables} and {@link Theme.elements} props.
5523
5539
  * @example
@@ -5546,7 +5562,7 @@ type Theme = {
5546
5562
  /**
5547
5563
  * The appearance of the CAPTCHA widget.
5548
5564
  * This will be used to style the CAPTCHA widget.
5549
- * Eg: `theme: 'dark'`
5565
+ * Eg: `captcha: { theme: 'dark' }`
5550
5566
  */
5551
5567
  captcha?: CaptchaAppearanceOptions;
5552
5568
  };
package/dist/index.d.ts CHANGED
@@ -5513,11 +5513,27 @@ type Variables = {
5513
5513
  type BaseThemeTaggedType = {
5514
5514
  __type: 'prebuilt_appearance';
5515
5515
  };
5516
- type BaseTheme = BaseThemeTaggedType & {
5516
+ type BaseTheme = (BaseThemeTaggedType | 'clerk' | 'simple') & {
5517
5517
  cssLayerName?: string;
5518
5518
  };
5519
5519
  type Theme = {
5520
5520
  /**
5521
+ * A theme used as the base theme for the components.
5522
+ * For further customisation, you can use the {@link Theme.layout}, {@link Theme.variables} and {@link Theme.elements} props.
5523
+ *
5524
+ * Supports both object-based themes and string-based themes:
5525
+ * @example
5526
+ * import { dark } from "@clerk/themes";
5527
+ * appearance={{ theme: dark }}
5528
+ *
5529
+ * @example
5530
+ * // Use string-based theme
5531
+ * appearance={{ theme: 'clerk' }}
5532
+ * appearance={{ theme: 'simple' }}
5533
+ */
5534
+ theme?: BaseTheme | BaseTheme[];
5535
+ /**
5536
+ * @deprecated Use `theme` instead. This property will be removed in a future version.
5521
5537
  * A theme used as the base theme for the components.
5522
5538
  * For further customisation, you can use the {@link Theme.layout}, {@link Theme.variables} and {@link Theme.elements} props.
5523
5539
  * @example
@@ -5546,7 +5562,7 @@ type Theme = {
5546
5562
  /**
5547
5563
  * The appearance of the CAPTCHA widget.
5548
5564
  * This will be used to style the CAPTCHA widget.
5549
- * Eg: `theme: 'dark'`
5565
+ * Eg: `captcha: { theme: 'dark' }`
5550
5566
  */
5551
5567
  captcha?: CaptchaAppearanceOptions;
5552
5568
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@clerk/types",
3
- "version": "4.70.1",
3
+ "version": "4.71.0-snapshot.v20250728160410",
4
4
  "description": "Typings for Clerk libraries.",
5
5
  "keywords": [
6
6
  "clerk",