UI Library for Design Engineers. Animated components and effects you can copy and paste into your apps. Free. Open Source.
feat: backticks support added in all component mdx (#491)
Arghya Das3980c917e0dd
diff --git a/content/docs/components/android.mdx b/content/docs/components/android.mdxindex 825e037d..967af1fd 100644--- a/content/docs/components/android.mdx+++ b/content/docs/components/android.mdx@@ -50,11 +50,11 @@ npx shadcn@latest add "https://magicui.design/r/android"## Props-| Prop | Type | Description | Default |-| -------- | ------ | ---------------------------------- | ------- |-| width | number | The width of the Android window | 433 |-| height | number | The height of the Android window | 882 |-| src | string | The source of the image to display | |-| videoSrc | string | The source of the video to display | |+| Prop | Type | Default | Description |+| ---------- | -------- | ------- | ---------------------------------- |+| `width` | `number` | `433` | The width of the Android window |+| `height` | `number` | `882` | The height of the Android window |+| `src` | `string` | `-` | The source of the image to display |+| `videoSrc` | `string` | `-` | The source of the video to display |The `Android` component also accepts all properties of the `SVGElement` type.diff --git a/content/docs/components/animated-beam.mdx b/content/docs/components/animated-beam.mdxindex bfd2c492..fa5eb762 100644--- a/content/docs/components/animated-beam.mdx+++ b/content/docs/components/animated-beam.mdx@@ -63,25 +63,25 @@ npx shadcn@latest add "https://magicui.design/r/animated-beam"### Animated Beam-| Prop | Type | Description | Default |-| ------------------ | ------- | -------------------------------------------------------- | --------- |-| className | string | The class name for the component. | - |-| containerRef | ref | The container ref. | - |-| fromRef | ref | The ref of the element from which the beam should start. | - |-| toRef | ref | The ref of the element to which the beam should end. | - |-| curvature | number | The curvature of the beam. | 0 |-| reverse | boolean | Whether the beam should be reversed. | false |-| duration | number | The duration of the beam. | 5 |-| delay | number | The delay of the beam. | 0 |-| pathColor | string | The color of the beam. | "gray" |-| pathWidth | number | The width of the beam. | 2 |-| pathOpacity | number | The opacity of the beam. | 0.2 |-| gradientStartColor | string | The start color of the gradient. | "#ffaa40" |-| gradientStopColor | string | The stop color of the gradient. | "#9c40ff" |-| startXOffset | number | The start x offset of the beam. | 0 |-| startYOffset | number | The start y offset of the beam. | 0 |-| endXOffset | number | The end x offset of the beam. | 0 |-| endYOffset | number | The end y offset of the beam. | 0 |+| Prop | Type | Default | Description |+| -------------------- | --------- | --------- | -------------------------------------------------------- |+| `className` | `string` | `-` | The class name for the component. |+| `containerRef` | `ref` | `-` | The container ref. |+| `fromRef` | `ref` | `-` | The ref of the element from which the beam should start. |+| `toRef` | `ref` | `-` | The ref of the element to which the beam should end. |+| `curvature` | `number` | `0` | The curvature of the beam. |+| `reverse` | `boolean` | `false` | Whether the beam should be reversed. |+| `duration` | `number` | `5` | The duration of the beam. |+| `delay` | `number` | `0` | The delay of the beam. |+| `pathColor` | `string` | `gray` | The color of the beam. |+| `pathWidth` | `number` | `2` | The width of the beam. |+| `pathOpacity` | `number` | `0.2` | The opacity of the beam. |+| `gradientStartColor` | `string` | `#ffaa40` | The start color of the gradient. |+| `gradientStopColor` | `string` | `#9c40ff` | The stop color of the gradient. |+| `startXOffset` | `number` | `0` | The start x offset of the beam. |+| `startYOffset` | `number` | `0` | The start y offset of the beam. |+| `endXOffset` | `number` | `0` | The end x offset of the beam. |+| `endYOffset` | `number` | `0` | The end y offset of the beam. |## Creditsdiff --git a/content/docs/components/animated-circular-progress-bar.mdx b/content/docs/components/animated-circular-progress-bar.mdxindex 3e8ba095..07474753 100644--- a/content/docs/components/animated-circular-progress-bar.mdx+++ b/content/docs/components/animated-circular-progress-bar.mdx@@ -42,14 +42,14 @@ npx shadcn@latest add "https://magicui.design/r/animated-circular-progress-bar"## Props-| Prop | Type | Description | Default |-| ------------------- | ------ | --------------------------------------------- | ------- |-| className | string | The class name to be applied to the component | |-| max | number | The maximum value of the gauge | 100 |-| min | number | The minimum value of the gauge | 0 |-| value | number | The current value of the gauge | 0 |-| gaugePrimaryColor | string | The primary color of the gauge | |-| gaugeSecondaryColor | string | The secondary color of the gauge | |+| Prop | Type | Default | Description |+| --------------------- | -------- | ------- | --------------------------------------------- |+| `className` | `string` | `-` | The class name to be applied to the component |+| `max` | `number` | `100` | The maximum value of the gauge |+| `min` | `number` | `0` | The minimum value of the gauge |+| `value` | `number` | `0` | The current value of the gauge |+| `gaugePrimaryColor` | `string` | `-` | The primary color of the gauge |+| `gaugeSecondaryColor` | `string` | `-` | The secondary color of the gauge |## Creditsdiff --git a/content/docs/components/animated-gradient-text.mdx b/content/docs/components/animated-gradient-text.mdxindex 7b215c77..0e0c2ad6 100644--- a/content/docs/components/animated-gradient-text.mdx+++ b/content/docs/components/animated-gradient-text.mdx@@ -67,7 +67,7 @@ module.exports = {## Props-| Prop | Type | Description | Default |-| --------- | ------ | -------------------------------------- | ------- |-| children | | The children passed into the component | |-| className | string | The class name to be applied. | |+| Prop | Type | Default | Description |+| ----------- | -------- | ------- | -------------------------------------- |+| `children` | `node` | `-` | The children passed into the component |+| `className` | `string` | `-` | The class name to be applied. |diff --git a/content/docs/components/animated-grid-pattern.mdx b/content/docs/components/animated-grid-pattern.mdxindex 7d18658c..0e877504 100644--- a/content/docs/components/animated-grid-pattern.mdx+++ b/content/docs/components/animated-grid-pattern.mdx@@ -44,15 +44,15 @@ npx shadcn@latest add "https://magicui.design/r/animated-grid-pattern"### GridPattern-| Prop | Type | Description | Default |-| --------------- | ------ | --------------------------------------------- | ------- |-| className | string | Additional classes to be added to the pattern | - |-| width | number | Width of the pattern | 40 |-| height | number | Height of the pattern | 40 |-| x | number | X offset of the pattern | -1 |-| y | number | Y offset of the pattern | -1 |-| strokeDasharray | number | Stroke dash array of the pattern | 0 |-| numSquares | number | Number of squares in the pattern | 200 |-| maxOpacity | number | Maximum opacity of the pattern | 0.5 |-| duration | number | Duration of the animation | 1 |-| repeatDelay | number | Repeat delay of the animation | 0.5 |+| Prop | Type | Default | Description |+| ----------------- | -------- | ------- | --------------------------------------------- |+| `className` | `string` | `-` | Additional classes to be added to the pattern |+| `width` | `number` | `40` | Width of the pattern |+| `height` | `number` | `40` | Height of the pattern |+| `x` | `number` | `-1` | X offset of the pattern |+| `y` | `number` | `-1` | Y offset of the pattern |+| `strokeDasharray` | `number` | `0` | Stroke dash array of the pattern |+| `numSquares` | `number` | `200` | Number of squares in the pattern |+| `maxOpacity` | `number` | `0.5` | Maximum opacity of the pattern |+| `duration` | `number` | `1` | Duration of the animation |+| `repeatDelay` | `number` | `0.5` | Repeat delay of the animation |diff --git a/content/docs/components/animated-list.mdx b/content/docs/components/animated-list.mdxindex aec58af3..09fffe23 100644--- a/content/docs/components/animated-list.mdx+++ b/content/docs/components/animated-list.mdx@@ -44,7 +44,7 @@ npx shadcn@latest add "https://magicui.design/r/animated-list"### Animated List-| Prop | Type | Description | Default |-| --------- | ------ | --------------------------------- | ------- |-| className | string | The class name for the component | "" |-| delay | number | The delay between each item in ms | 1000 |+| Prop | Type | Default | Description |+| ----------- | -------- | ------- | --------------------------------- |+| `className` | `string` | `-` | The class name for the component |+| `delay` | `number` | `1000` | The delay between each item in ms |diff --git a/content/docs/components/animated-shiny-text.mdx b/content/docs/components/animated-shiny-text.mdxindex 4e9a1b9c..1f74ada5 100644--- a/content/docs/components/animated-shiny-text.mdx+++ b/content/docs/components/animated-shiny-text.mdx@@ -70,8 +70,8 @@ module.exports = {## Props-| Prop | Type | Description | Default |-| ------------ | ------ | -------------------------------------------- | ------- |-| children | | The text to be shimmered. | |-| className | string | The class name to be applied to the shimmer. | |-| shimmerWidth | number | The width of the shimmer in pixels. | 100 |+| Prop | Type | Default | Description |+| -------------- | -------- | ------- | -------------------------------------------- |+| `children` | `node` | `-` | The text to be shimmered. |+| `className` | `string` | `-` | The class name to be applied to the shimmer. |+| `shimmerWidth` | `number` | `100` | The width of the shimmer in pixels. |diff --git a/content/docs/components/animated-subscribe-button.mdx b/content/docs/components/animated-subscribe-button.mdxindex a404f325..5f17aa9b 100644--- a/content/docs/components/animated-subscribe-button.mdx+++ b/content/docs/components/animated-subscribe-button.mdx@@ -42,13 +42,13 @@ npx shadcn@latest add "https://magicui.design/r/animated-subscribe-button"## Props-| Prop | Type | Description |-| --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| buttonColor | string | The accent color for the button. This allows you to set a custom color that matches your brand's theme. |-| buttonTextColor | string | The color of the button text. This allows you to ensure the text is visible and matches your desired color scheme. |-| subscribeStatus | boolean | A boolean flag to check the condition for the button. This property can be used to toggle the button's state, such as subscribed or unsubscribed. |-| initialText | string | The initial text displayed on the button. This is useful for setting a default label when the button first appears. |-| changeText | string | The final text displayed on the button after an action has been taken. This can be used to indicate a state change, such as from "Subscribe" to "Subscribed". |+| Prop | Type | Default | Description |+| ----------------- | --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| `buttonColor` | `string` | `-` | The accent color for the button. This allows you to set a custom color that matches your brand's theme. |+| `buttonTextColor` | `string` | `-` | The color of the button text. This allows you to ensure the text is visible and matches your desired color scheme. |+| `subscribeStatus` | `boolean` | `-` | A boolean flag to check the condition for the button. This property can be used to toggle the button's state, such as subscribed or unsubscribed. |+| `initialText` | `string` | `-` | The initial text displayed on the button. This is useful for setting a default label when the button first appears. |+| `changeText` | `string` | `-` | The final text displayed on the button after an action has been taken. This can be used to indicate a state change, such as from "Subscribe" to "Subscribed". |## Creditsdiff --git a/content/docs/components/avatar-circles.mdx b/content/docs/components/avatar-circles.mdxindex 4d679d14..836d9de0 100644--- a/content/docs/components/avatar-circles.mdx+++ b/content/docs/components/avatar-circles.mdx@@ -42,7 +42,7 @@ npx shadcn@latest add "https://magicui.design/r/avatar-circles"## Props-| Prop | Type | Description | Default |-| --------- | ------ | --------------------------------------------- | ------- |-| className | string | The class name to be applied to the component | |-| numPeople | number | The number appearing in the last circle | 99 |+| Prop | Type | Default | Description |+| ----------- | -------- | ------- | --------------------------------------------- |+| `className` | `string` | `-` | The class name to be applied to the component |+| `numPeople` | `number` | `99` | The number appearing in the last circle |diff --git a/content/docs/components/blur-fade.mdx b/content/docs/components/blur-fade.mdxindex 1c822fd4..4e45e253 100644--- a/content/docs/components/blur-fade.mdx+++ b/content/docs/components/blur-fade.mdx@@ -46,15 +46,15 @@ npx shadcn@latest add "https://magicui.design/r/blur-fade"## Props-| Prop | Type | Description | Default |-| ------------ | --------------- | ----------------------------------------------------------- | ------- |-| children | React.ReactNode | The content to be animated | |-| className | string | The class name to be applied to the component | |-| variant | object | Custom animation variants for motion component | |-| duration | number | Duration (seconds) for the animation | 0.4 |-| delay | number | Delay (seconds) before the animation starts | 0 |-| offset | number | Offset for the animation | 6 |-| direction | string | Direction for the animation (`up`, `down`, `left`, `right`) | "down" |-| inView | boolean | Whether to trigger animation when component is in view | false |-| inViewMargin | MarginType | Margin for triggering the in-view animation | "-50px" |-| blur | string | Amount of blur to apply during the animation | "6px" |+| Prop | Type | Default | Description |+| -------------- | ----------------- | --------- | ----------------------------------------------------------- |+| `children` | `React.ReactNode` | `-` | The content to be animated |+| `className` | `string` | `-` | The class name to be applied to the component |+| `variant` | `object` | `-` | Custom animation variants for motion component |+| `duration` | `number` | `0.4` | Duration (seconds) for the animation |+| `delay` | `number` | `0` | Delay (seconds) before the animation starts |+| `offset` | `number` | `6` | Offset for the animation |+| `direction` | `string` | `"down"` | Direction for the animation (`up`, `down`, `left`, `right`) |+| `inView` | `boolean` | `false` | Whether to trigger animation when component is in view |+| `inViewMargin` | `MarginType` | `"-50px"` | Margin for triggering the in-view animation |+| `blur` | `string` | `"6px"` | Amount of blur to apply during the animation |diff --git a/content/docs/components/border-beam.mdx b/content/docs/components/border-beam.mdxindex 257089c3..458c7b95 100644--- a/content/docs/components/border-beam.mdx+++ b/content/docs/components/border-beam.mdx@@ -85,16 +85,16 @@ export default async function App() {### Border Beam-| Prop | Type | Description | Default |-| ----------- | ------ | -------------------------------------- | ------- |-| className | string | Custom class to apply to the component | - |-| size | number | Size of the beam | 300 |-| duration | number | Duration of the animation | 15 |-| anchor | number | Anchor point of the beam | 90 |-| borderWidth | number | Width of the beam | 1.5 |-| colorFrom | string | Start color of the beam | #ffaa40 |-| colorTo | string | End color of the beam | #9c40ff |-| delay | number | Delay before the animation starts | 0 |+| Prop | Type | Default | Description |+| ------------- | -------- | --------- | -------------------------------------- |+| `className` | `string` | `-` | Custom class to apply to the component |+| `size` | `number` | `300` | Size of the beam |+| `duration` | `number` | `15` | Duration of the animation |+| `anchor` | `number` | `90` | Anchor point of the beam |+| `borderWidth` | `number` | `1.5` | Width of the beam |+| `colorFrom` | `string` | `#ffaa40` | Start color of the beam |+| `colorTo` | `string` | `#9c40ff` | End color of the beam |+| `delay` | `number` | `0` | Delay before the animation starts |## Creditsdiff --git a/content/docs/components/box-reveal.mdx b/content/docs/components/box-reveal.mdxindex d0329282..ba400666 100644--- a/content/docs/components/box-reveal.mdx+++ b/content/docs/components/box-reveal.mdx@@ -42,8 +42,8 @@ npx shadcn@latest add "https://magicui.design/r/box-reveal"## Props-| Prop | Type | Description | Default |-| --------- | ------ | --------------------------------------------- | ------- |-| className | string | The class name to be applied to the component | |-| boxColor | string | Color of the box overlaying the text | #5046e6 |-| duration | number | Durations (seconds) of the animation | 0.5 |+| Prop | Type | Default | Description |+| ----------- | -------- | --------- | --------------------------------------------- |+| `className` | `string` | `-` | The class name to be applied to the component |+| `boxColor` | `string` | `#5046e6` | Color of the box overlaying the text |+| `duration` | `number` | `0.5` | Durations (seconds) of the animation |diff --git a/content/docs/components/code-comparison.mdx b/content/docs/components/code-comparison.mdxindex 95cb659a..a5562b66 100644--- a/content/docs/components/code-comparison.mdx+++ b/content/docs/components/code-comparison.mdx@@ -40,12 +40,12 @@ npx shadcn@latest add "https://magicui.design/r/code-comparison"## Props-| Prop | Type | Description | Default |-| ---------- | -------- | ------------------------------------------------------ | -------------- |-| className | `string` | The class name to be applied to the component | |-| beforeCode | `string` | The code snippet to display in the "before" section | |-| afterCode | `string` | The code snippet to display in the "after" section | |-| language | `string` | The language of the code snippets (e.g., "typescript") | |-| filename | `string` | The filename to display for the code snippets | |-| lightTheme | `string` | The theme to use for light mode | "github-light" |-| darkTheme | `string` | The theme to use for dark mode | "github-dark" |+| Prop | Type | Default | Description |+| ------------ | -------- | -------------- | ------------------------------------------------------ |+| `className` | `string` | `-` | The class name to be applied to the component |+| `beforeCode` | `string` | `-` | The code snippet to display in the "before" section |+| `afterCode` | `string` | `-` | The code snippet to display in the "after" section |+| `language` | `string` | `-` | The language of the code snippets (e.g., "typescript") |+| `filename` | `string` | `-` | The filename to display for the code snippets |+| `lightTheme` | `string` | `github-light` | The theme to use for light mode |+| `darkTheme` | `string` | `github-dark` | The theme to use for dark mode |diff --git a/content/docs/components/confetti.mdx b/content/docs/components/confetti.mdxindex c3594d24..9c1725c3 100644--- a/content/docs/components/confetti.mdx+++ b/content/docs/components/confetti.mdx@@ -80,33 +80,33 @@ npm install canvas-confetti### Confetti-| Prop | Type | Description | Default |-| ----------------------- | ------------------------- | ------------------------------------------------ | ----------------------------------------------------------------------------- |-| particleCount | Integer | The number of confetti particles to launch | 50 |-| angle | Number | The angle in degrees at which to launch confetti | 90 |-| spread | Number | The spread in degrees of the confetti | 45 |-| startVelocity | Number | The initial velocity of the confetti | 45 |-| decay | Number | The rate at which confetti slows down | 0.9 |-| gravity | Number | The gravity applied to confetti particles | 1 |-| drift | Number | The horizontal drift applied to particles | 0 |-| flat | Boolean | Whether confetti particles are flat | false |-| ticks | Number | The number of frames confetti lasts | 200 |-| origin | Object | The origin point of the confetti | `{ x: 0.5, y: 0.5 }` |-| colors | Array of Strings | Array of color strings in HEX format | ['#26ccff', '#a25afd', '#ff5e7e', '#88ff5a', '#fcff42', '#ffa62d', '#ff36ff'] |-| shapes | Array of Strings | Array of shapes for the confetti | ['square', 'circle'] |-| zIndex | Integer | The z-index of the confetti | 100 |-| disableForReducedMotion | Boolean | Disables confetti for users who prefer no motion | false |-| useWorker | Boolean | Use Web Worker for better performance | true |-| resize | Boolean | Whether to resize the canvas | true |-| canvas | HTMLCanvasElement or null | Custom canvas element to draw confetti | null |-| scalar | Number | Scaling factor for confetti size | 1 |+| Prop | Type | Default | Description |+| ------------------------- | --------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------ |+| `particleCount` | `Integer` | `50` | The number of confetti particles to launch |+| `angle` | `Number` | `90` | The angle in degrees at which to launch confetti |+| `spread` | `Number` | `45` | The spread in degrees of the confetti |+| `startVelocity` | `Number` | `45` | The initial velocity of the confetti |+| `decay` | `Number` | `0.9` | The rate at which confetti slows down |+| `gravity` | `Number` | `1` | The gravity applied to confetti particles |+| `drift` | `Number` | `0` | The horizontal drift applied to particles |+| `flat` | `Boolean` | `false` | Whether confetti particles are flat |+| `ticks` | `Number` | `200` | The number of frames confetti lasts |+| `origin` | `Object` | `{ x: 0.5, y: 0.5 }` | The origin point of the confetti |+| `colors` | `Array of Strings` | `['#26ccff', '#a25afd', '#ff5e7e', '#88ff5a', '#fcff42', '#ffa62d', '#ff36ff']` | Array of color strings in HEX format |+| `shapes` | `Array of Strings` | `['square', 'circle']` | Array of shapes for the confetti |+| `zIndex` | `Integer` | `100` | The z-index of the confetti |+| `disableForReducedMotion` | `Boolean` | `false` | Disables confetti for users who prefer no motion |+| `useWorker` | `Boolean` | `true` | Use Web Worker for better performance |+| `resize` | `Boolean` | `true` | Whether to resize the canvas |+| `canvas` | `HTMLCanvasElement or null` | `null` | Custom canvas element to draw confetti |+| `scalar` | `Number` | `1` | Scaling factor for confetti size |### ConfettiButton-| Prop | Type | Description | Default |-| -------- | --------------- | ------------------------------------ | ------- |-| options | Object | Options for the confetti | {} |-| children | React.ReactNode | Children to render inside the button | null |+| Prop | Type | Default | Description |+| ---------- | ----------------- | ------- | ------------------------------------ |+| `options` | `Object` | `{}` | Options for the confetti |+| `children` | `React.ReactNode` | `null` | Children to render inside the button |## Creditsdiff --git a/content/docs/components/cool-mode.mdx b/content/docs/components/cool-mode.mdxindex e0ec185f..25809b8d 100644--- a/content/docs/components/cool-mode.mdx+++ b/content/docs/components/cool-mode.mdx@@ -48,13 +48,13 @@ npx shadcn@latest add "https://magicui.design/r/cool-mode"## Props-| Prop | Type | Description | Default |-| ------------- | ------ | -------------------------------------- | -------- |-| particle | String | The particle URL for a custom particle | "circle" |-| size | Number | Size of the particle | Varies |-| particleCount | Number | The number of particles to generate | Varies |-| speedHorz | Number | Horizontal speed of the particles | Varies |-| speedUp | Number | Upward speed of the particles | Varies |+| Prop | Type | Default | Description |+| --------------- | -------- | ---------- | -------------------------------------- |+| `particle` | `String` | `"circle"` | The particle URL for a custom particle |+| `size` | `Number` | `Varies` | Size of the particle |+| `particleCount` | `Number` | `Varies` | The number of particles to generate |+| `speedHorz` | `Number` | `Varies` | Horizontal speed of the particles |+| `speedUp` | `Number` | `Varies` | Upward speed of the particles |## Creditsdiff --git a/content/docs/components/dock.mdx b/content/docs/components/dock.mdxindex 2eb3f9b7..0bb65687 100644--- a/content/docs/components/dock.mdx+++ b/content/docs/components/dock.mdx@@ -55,26 +55,26 @@ npx shadcn@latest add "https://magicui.design/r/dock"### Dock-| Prop | Type | Description | Default |-| ----------------- | --------- | ------------------------------------ | -------- |-| className | string | Custom CSS class for styling | - |-| children | ReactNode | Children elements | - |-| iconSize | number | Size of the icon | 40 |-| iconMagnification | number | Level of icon magnification | 60 |-| iconDistance | number | Distance from cursor to magnify icon | 140 |-| direction | string | Direction of the dock | "middle" |+| Prop | Type | Default | Description |+| ------------------- | ----------- | ---------- | ------------------------------------ |+| `className` | `string` | `-` | Custom CSS class for styling |+| `children` | `ReactNode` | `-` | Children elements |+| `iconSize` | `number` | `40` | Size of the icon |+| `iconMagnification` | `number` | `60` | Level of icon magnification |+| `iconDistance` | `number` | `140` | Distance from cursor to magnify icon |+| `direction` | `string` | `"middle"` | Direction of the dock |### DockIcon-| Prop | Type | Description | Default |-| ------------- | ----------------- | ------------------------------------ | ------- |-| size | number | Size of the icon | 40 |-| magnification | number | Level of icon magnification | 60 |-| distance | number | Distance from cursor to magnify icon | 140 |-| mouseX | any | Mouse X position for magnification | - |-| className | string | Custom CSS class for styling | - |-| children | React.ReactNode | Children elements | - |-| props | PropsWithChildren | Additional props | - |+| Prop | Type | Default | Description |+| --------------- | ------------------- | ------- | ------------------------------------ |+| `size` | `number` | `40` | Size of the icon |+| `magnification` | `number` | `60` | Level of icon magnification |+| `distance` | `number` | `140` | Distance from cursor to magnify icon |+| `mouseX` | `any` | `-` | Mouse X position for magnification |+| `className` | `string` | `-` | Custom CSS class for styling |+| `children` | `React.ReactNode` | `-` | Children elements |+| `props` | `PropsWithChildren` | `-` | Additional props |## Creditsdiff --git a/content/docs/components/dot-pattern.mdx b/content/docs/components/dot-pattern.mdxindex 7d1d9c24..084d5e28 100644--- a/content/docs/components/dot-pattern.mdx+++ b/content/docs/components/dot-pattern.mdx@@ -51,13 +51,13 @@ npx shadcn@latest add "https://magicui.design/r/dot-pattern"### Dot Pattern-| Prop | Type | Description | Default |-| --------- | ------ | ----------------------------- | ------- |-| width | any | Width of the dot pattern | 16 |-| height | any | Height of the dot pattern | 16 |-| x | any | X position of the dot | 0 |-| y | any | Y position of the dot | 0 |-| cx | any | X position of the circle | 1 |-| cy | any | Y position of the circle | 1 |-| cr | any | Radius of the circle | 1 |-| className | string | Class name of the dot pattern | - |+| Prop | Type | Default | Description |+| ----------- | -------- | ------- | ----------------------------- |+| `width` | `any` | `16` | Width of the dot pattern |+| `height` | `any` | `16` | Height of the dot pattern |+| `x` | `any` | `0` | X position of the dot |+| `y` | `any` | `0` | Y position of the dot |+| `cx` | `any` | `1` | X position of the circle |+| `cy` | `any` | `1` | Y position of the circle |+| `cr` | `any` | `1` | Radius of the circle |+| `className` | `string` | `-` | Class name of the dot pattern |diff --git a/content/docs/components/file-tree.mdx b/content/docs/components/file-tree.mdxindex f2a10f62..241df3f2 100644--- a/content/docs/components/file-tree.mdx+++ b/content/docs/components/file-tree.mdx@@ -46,35 +46,35 @@ npx shadcn@latest add "https://magicui.design/r/file-tree"| Prop | Type | Default | Description || ---------------------- | ------------------- | ------- | ------------------------------------------------------------ |-| `initialSelectedId` | `string` | - | The ID of the initially selected item. |+| `initialSelectedId` | `string` | `-` | The ID of the initially selected item. || `indicator` | `boolean` | `true` | Whether to show the tree indicator line. |-| `elements` | `TreeViewElement[]` | - | An array of tree view elements to render. |-| `initialExpandedItems` | `string[]` | - | An array of IDs for items that should be initially expanded. |-| `openIcon` | `React.ReactNode` | - | Custom icon for open folders. |-| `closeIcon` | `React.ReactNode` | - | Custom icon for closed folders. |+| `elements` | `TreeViewElement[]` | `-` | An array of tree view elements to render. |+| `initialExpandedItems` | `string[]` | `-` | An array of IDs for items that should be initially expanded. |+| `openIcon` | `React.ReactNode` | `-` | Custom icon for open folders. |+| `closeIcon` | `React.ReactNode` | `-` | Custom icon for closed folders. || `dir` | `"rtl" \| "ltr"` | `"ltr"` | The text direction of the tree. |### Folder| Prop | Type | Default | Description || -------------- | --------- | ------- | ----------------------------------------- |-| `element` | `string` | - | The name of the folder. |-| `value` | `string` | - | The unique identifier for the folder. |+| `element` | `string` | `-` | The name of the folder. |+| `value` | `string` | `-` | The unique identifier for the folder. || `isSelectable` | `boolean` | `true` | Whether the folder can be selected. |-| `isSelect` | `boolean` | - | Whether the folder is currently selected. |+| `isSelect` | `boolean` | `-` | Whether the folder is currently selected. |### File| Prop | Type | Default | Description || -------------- | ----------------- | ------- | --------------------------------------- |-| `value` | `string` | - | The unique identifier for the file. |+| `value` | `string` | `-` | The unique identifier for the file. || `isSelectable` | `boolean` | `true` | Whether the file can be selected. |-| `isSelect` | `boolean` | - | Whether the file is currently selected. |-| `fileIcon` | `React.ReactNode` | - | Custom icon for the file. |+| `isSelect` | `boolean` | `-` | Whether the file is currently selected. |+| `fileIcon` | `React.ReactNode` | `-` | Custom icon for the file. |### CollapseButton| Prop | Type | Default | Description || ----------- | ------------------- | ------- | ------------------------------------------ |-| `elements` | `TreeViewElement[]` | - | An array of tree view elements to control. |+| `elements` | `TreeViewElement[]` | `-` | An array of tree view elements to control. || `expandAll` | `boolean` | `false` | Whether to expand all elements initially. |diff --git a/content/docs/components/flickering-grid.mdx b/content/docs/components/flickering-grid.mdxindex 2bfca5ab..4fe98979 100644--- a/content/docs/components/flickering-grid.mdx+++ b/content/docs/components/flickering-grid.mdx@@ -48,13 +48,13 @@ npx shadcn@latest add "https://magicui.design/r/flickering-grid"## Props-| Prop | Type | Description | Default |-| ------------- | ------ | ------------------------------------- | -------------- |-| squareSize | number | Size of each square in the grid | 4 |-| gridGap | number | Gap between squares in the grid | 6 |-| flickerChance | number | Probability of a square flickering | 0.3 |-| color | string | Color of the squares | "rgb(0, 0, 0)" |-| width | number | Width of the canvas | - |-| height | number | Height of the canvas | - |-| className | string | Additional CSS classes for the canvas | - |-| maxOpacity | number | Maximum opacity of the squares | 0.2 |+| Prop | Type | Default | Description |+| --------------- | -------- | ---------------- | ------------------------------------- |+| `squareSize` | `number` | `4` | Size of each square in the grid |+| `gridGap` | `number` | `6` | Gap between squares in the grid |+| `flickerChance` | `number` | `0.3` | Probability of a square flickering |+| `color` | `string` | `"rgb(0, 0, 0)"` | Color of the squares |+| `width` | `number` | `-` | Width of the canvas |+| `height` | `number` | `-` | Height of the canvas |+| `className` | `string` | `-` | Additional CSS classes for the canvas |+| `maxOpacity` | `number` | `0.2` | Maximum opacity of the squares |diff --git a/content/docs/components/flip-text.mdx b/content/docs/components/flip-text.mdxindex 94175b2d..a23ddfdf 100644--- a/content/docs/components/flip-text.mdx+++ b/content/docs/components/flip-text.mdx@@ -42,10 +42,10 @@ npx shadcn@latest add "https://magicui.design/r/flip-text"## Props-| Prop | Type | Description | Default |-| ------------- | --------------- | --------------------------------------------- | ------- |-| className | string | The class name to be applied to the component | |-| duration | number | Duration of the animation | 0.2 |-| delayMultiple | number | Transition delay multiplier. | 0.08 |-| word | string | An array of words to rotate through | "" |-| motionProps | HTMLMotionProps | An object containing motion animation props | {} |+| Prop | Type | Default | Description |+| --------------- | ----------------- | ------- | --------------------------------------------- |+| `className` | `string` | `-` | The class name to be applied to the component |+| `duration` | `number` | `0.2` | Duration of the animation |+| `delayMultiple` | `number` | `0.08` | Transition delay multiplier. |+| `word` | `string` | `""` | An array of words to rotate through |+| `motionProps` | `HTMLMotionProps` | `{}` | An object containing motion animation props |diff --git a/content/docs/components/globe.mdx b/content/docs/components/globe.mdxindex ce88fd9f..fb9070b6 100644--- a/content/docs/components/globe.mdx+++ b/content/docs/components/globe.mdx@@ -56,10 +56,10 @@ npm install cobe### Globe-| Prop | Type | Description | Default |-| --------- | ----------- | ---------------------------------------------------------------------------------------------- | ------- |-| className | string | The css classes for the component | |-| config | COBEOptions | The configuration options for the globe. More details [here](https://cobe.vercel.app/docs/api) | `{}` |+| Prop | Type | Default | Description |+| ----------- | ------------- | ------- | ---------------------------------------------------------------------------------------------- |+| `className` | `string` | `-` | The css classes for the component |+| `config` | `COBEOptions` | `{}` | The configuration options for the globe. More details [here](https://cobe.vercel.app/docs/api) |## Creditsdiff --git a/content/docs/components/grid-pattern.mdx b/content/docs/components/grid-pattern.mdxindex 2e3fa0d6..bd7b083f 100644--- a/content/docs/components/grid-pattern.mdx+++ b/content/docs/components/grid-pattern.mdx@@ -55,11 +55,11 @@ npx shadcn@latest add "https://magicui.design/r/grid-pattern"### GridPattern-| Prop | Type | Description | Default |-| --------------- | ------ | --------------------------------------------- | ------- |-| width | number | Width of the pattern | 40 |-| height | number | Height of the pattern | 40 |-| x | number | X offset of the pattern | -1 |-| y | number | Y offset of the pattern | -1 |-| squares | number | X Y coordinates of filled squares as 2D array | [] |-| strokeDasharray | string | Stroke dash array for the pattern | 0 |+| Prop | Type | Default | Description |+| ----------------- | -------- | ------- | --------------------------------------------- |+| `width` | `number` | `40` | Width of the pattern |+| `height` | `number` | `40` | Height of the pattern |+| `x` | `number` | `-1` | X offset of the pattern |+| `y` | `number` | `-1` | Y offset of the pattern |+| `squares` | `number` | `[]` | X Y coordinates of filled squares as 2D array |+| `strokeDasharray` | `string` | `0` | Stroke dash array for the pattern |diff --git a/content/docs/components/hero-video-dialog.mdx b/content/docs/components/hero-video-dialog.mdxindex b969b204..240504da 100644--- a/content/docs/components/hero-video-dialog.mdx+++ b/content/docs/components/hero-video-dialog.mdx@@ -48,12 +48,12 @@ npx shadcn@latest add "https://magicui.design/r/hero-video-dialog"## Props-| Prop | Type | Description | Default |-| -------------- | ------ | -------------------------------- | ----------------- |-| animationStyle | string | Animation style for the dialog | "from-center" |-| videoSrc | string | URL of the video to be played | - |-| thumbnailSrc | string | URL of the thumbnail image | - |-| thumbnailAlt | string | Alt text for the thumbnail image | "Video thumbnail" |+| Prop | Type | Default | Description |+| ---------------- | -------- | ------------------- | -------------------------------- |+| `animationStyle` | `string` | `"from-center"` | Animation style for the dialog |+| `videoSrc` | `string` | `-` | URL of the video to be played |+| `thumbnailSrc` | `string` | `-` | URL of the thumbnail image |+| `thumbnailAlt` | `string` | `"Video thumbnail"` | Alt text for the thumbnail image |## Animation Stylesdiff --git a/content/docs/components/hyper-text.mdx b/content/docs/components/hyper-text.mdxindex 72cfa6fd..03b5b476 100644--- a/content/docs/components/hyper-text.mdx+++ b/content/docs/components/hyper-text.mdx@@ -48,13 +48,13 @@ npm install motion## Props-| Prop | Type | Description | Default |-| -------------- | ----------------- | --------------------------------------------- | ------- |-| children | string | Text content to animate | |-| className | string | The class name to be applied to the component | |-| duration | number | Duration of the animation in milliseconds | 800 |-| delay | number | Delay before animation starts (in ms) | 0 |-| as | React.ElementType | Component to render as | "div" |-| startOnView | boolean | Start animation when component is in view | false |-| animateOnHover | boolean | Enable hover animation | true |-| characterSet | string[] | Custom character set for scramble effect | A-Z |+| Prop | Type | Default | Description |+| ---------------- | ------------------- | ------- | --------------------------------------------- |+| `children` | `string` | `-` | Text content to animate |+| `className` | `string` | `-` | The class name to be applied to the component |+| `duration` | `number` | `800` | Duration of the animation in milliseconds |+| `delay` | `number` | `0` | Delay before animation starts (in ms) |+| `as` | `React.ElementType` | `"div"` | Component to render as |+| `startOnView` | `boolean` | `false` | Start animation when component is in view |+| `animateOnHover` | `boolean` | `true` | Enable hover animation |+| `characterSet` | `string[]` | `A-Z` | Custom character set for scramble effect |diff --git a/content/docs/components/icon-cloud.mdx b/content/docs/components/icon-cloud.mdxindex 867b06f7..9518c9e4 100644--- a/content/docs/components/icon-cloud.mdx+++ b/content/docs/components/icon-cloud.mdx@@ -48,7 +48,7 @@ npx shadcn@latest add "https://magicui.design/r/icon-cloud"## Props-| Prop | Type | Description | Default |-| ------ | ----------------- | ------------------------------------------ | ------- |-| icons | React.ReactNode[] | Array of icons to render in the cloud | [] |-| images | string[] | Array of image URLs to render in the cloud | [] |+| Prop | Type | Default | Description |+| -------- | ------------------- | ------- | ------------------------------------------ |+| `icons` | `React.ReactNode[]` | `[]` | Array of icons to render in the cloud |+| `images` | `string[]` | `[]` | Array of image URLs to render in the cloud |diff --git a/content/docs/components/interactive-grid-pattern.mdx b/content/docs/components/interactive-grid-pattern.mdxindex 6b0ca04e..e6c651b2 100644--- a/content/docs/components/interactive-grid-pattern.mdx+++ b/content/docs/components/interactive-grid-pattern.mdx@@ -48,10 +48,10 @@ npx shadcn@latest add "https://magicui.design/r/interactive-grid-pattern"## Props-| Prop | Type | Description | Default |-| ---------------- | ---------------- | --------------------------------------------------------------------------------------------- | ------- |-| width | number | Width of each square in the grid | 40 |-| height | number | Height of each square in the grid | 40 |-| squares | [number, number] | Number of squares in the grid. First number is horizontal squares, second is vertical squares | [24,24] |-| className | string | Class name applied to the grid container | - |-| squaresClassName | string | Class name applied to individual squares in the grid | - |+| Prop | Type | Description | Default |+| ------------------ | ------------------ | --------------------------------------------------------------------------------------------- | --------- |+| `width` | `number` | Width of each square in the grid | `40` |+| `height` | `number` | Height of each square in the grid | `40` |+| `squares` | `[number, number]` | Number of squares in the grid. First number is horizontal squares, second is vertical squares | `[24,24]` |+| `className` | `string` | Class name applied to the grid container | - |+| `squaresClassName` | `string` | Class name applied to individual squares in the grid | - |diff --git a/content/docs/components/interactive-hover-button.mdx b/content/docs/components/interactive-hover-button.mdxindex 497cbe0f..14f624fd 100644--- a/content/docs/components/interactive-hover-button.mdx+++ b/content/docs/components/interactive-hover-button.mdx@@ -42,10 +42,10 @@ npx shadcn@latest add "https://magicui.design/r/interactive-hover-button"## Props-| Prop | Type | Description | Default |-| --------- | ------ | --------------------------------------------- | --------- |-| text | string | The text to be displayed inside the button | Button |-| className | string | Additional class names to style the component | Undefined |+| Prop | Type | Default | Description |+| ----------- | -------- | -------- | --------------------------------------------- |+| `text` | `string` | `Button` | The text to be displayed inside the button |+| `className` | `string` | `-` | Additional class names to style the component |## Creditsdiff --git a/content/docs/components/iphone-15-pro.mdx b/content/docs/components/iphone-15-pro.mdxindex 68dfa41b..4dcd99af 100644--- a/content/docs/components/iphone-15-pro.mdx+++ b/content/docs/components/iphone-15-pro.mdx@@ -52,11 +52,11 @@ npx shadcn@latest add "https://magicui.design/r/iphone-15-pro"## Props-| Prop | Type | Description | Default |-| -------- | ------ | -------------------------------------- | ------- |-| width | number | The width of the iPhone 15 Pro window | 433 |-| height | number | The height of the iPhone 15 Pro window | 882 |-| src | string | The source of the image to display | |-| videoSrc | string | The source of the video to display | |+| Prop | Type | Default | Description |+| ---------- | -------- | ------- | -------------------------------------- |+| `width` | `number` | `433` | The width of the iPhone 15 Pro window |+| `height` | `number` | `882` | The height of the iPhone 15 Pro window |+| `src` | `string` | `-` | The source of the image to display |+| `videoSrc` | `string` | `-` | The source of the video to display |The `Iphone15Pro` component also accepts all properties of the `SVGElement` type.diff --git a/content/docs/components/magic-card.mdx b/content/docs/components/magic-card.mdxindex 9071da77..b8373fd7 100644--- a/content/docs/components/magic-card.mdx+++ b/content/docs/components/magic-card.mdx@@ -44,15 +44,15 @@ npx shadcn@latest add "https://magicui.design/r/magic-card"### MagicCard-| Prop name | Type | Default | Description |-| --------------- | --------------- | --------- | ------------------------------------------- |-| children | React.ReactNode | - | The content to be rendered inside the card |-| className | string | - | Additional CSS classes to apply to the card |-| gradientSize | number | 200 | Size of the gradient effect |-| gradientColor | string | "#262626" | Color of the gradient effect |-| gradientOpacity | number | 0.8 | Opacity of the gradient effect |-| gradientFrom | string | "#9E7AFF" | Start color of the gradient border |-| gradientTo | string | "#FE8BBB" | End color of the gradient border |+| Prop name | Type | Default | Description |+| ----------------- | ----------------- | --------- | ------------------------------------------- |+| `children` | `React.ReactNode` | `-` | The content to be rendered inside the card |+| `className` | `string` | `-` | Additional CSS classes to apply to the card |+| `gradientSize` | `number` | `200` | Size of the gradient effect |+| `gradientColor` | `string` | `#262626` | Color of the gradient effect |+| `gradientOpacity` | `number` | `0.8` | Opacity of the gradient effect |+| `gradientFrom` | `string` | `#9E7AFF` | Start color of the gradient border |+| `gradientTo` | `string` | `#FE8BBB` | End color of the gradient border |## Creditsdiff --git a/content/docs/components/marquee.mdx b/content/docs/components/marquee.mdxindex 57e5fc2b..520a498a 100644--- a/content/docs/components/marquee.mdx+++ b/content/docs/components/marquee.mdx@@ -81,11 +81,11 @@ module.exports = {## Props-| Prop | Type | Default | Description |-| ------------ | ------- | ------- | ---------------------------------------------------------------------------- |-| className | string | | The class name to apply to the component. |-| reverse | boolean | false | Whether or not to reverse the direction of the marquee. |-| pauseOnHover | boolean | false | Whether or not to pause the marquee when the user hovers over the component. |-| vertical | boolean | false | Whether or not to display the marquee vertically. |-| children | node | | The content to display in the marquee. |-| repeat | number | 1 | The number of times to repeat the content. |+| Prop | Type | Default | Description |+| -------------- | --------- | ------- | ---------------------------------------------------------------------------- |+| `className` | `string` | `-` | The class name to apply to the component. |+| `reverse` | `boolean` | `false` | Whether or not to reverse the direction of the marquee. |+| `pauseOnHover` | `boolean` | `false` | Whether or not to pause the marquee when the user hovers over the component. |+| `vertical` | `boolean` | `false` | Whether or not to display the marquee vertically. |+| `children` | `node` | `-` | The content to display in the marquee. |+| `repeat` | `number` | `1` | The number of times to repeat the content. |diff --git a/content/docs/components/meteors.mdx b/content/docs/components/meteors.mdxindex 6b31fec8..0a85aa61 100644--- a/content/docs/components/meteors.mdx+++ b/content/docs/components/meteors.mdx@@ -72,6 +72,6 @@ module.exports = {### Meteors-| Prop | Type | Description | Default |-| ------ | ------ | ----------------- | ------- |-| number | number | Number of meteors | 20 |+| Prop | Type | Default | Description |+| -------- | -------- | ------- | ----------------- |+| `number` | `number` | `20` | Number of meteors |diff --git a/content/docs/components/morphing-text.mdx b/content/docs/components/morphing-text.mdxindex bf97ad5d..0e886e80 100644--- a/content/docs/components/morphing-text.mdx+++ b/content/docs/components/morphing-text.mdx@@ -40,10 +40,10 @@ npx shadcn@latest add "https://magicui.design/r/morphing-text"## Props-| Prop | Type | Description | Default |-| ----------- | ---------- | ------------------------------------ | ------- |-| `texts` | `string[]` | Array of texts to morph between | `[]` |-| `className` | `string?` | Additional classes for the container | `""` |+| Prop | Type | Default | Description |+| ----------- | ---------- | ------- | ------------------------------------ |+| `texts` | `string[]` | `[]` | Array of texts to morph between |+| `className` | `string?` | `""` | Additional classes for the container |This `MorphingText` component dynamically transitions between an array of text strings, creating a smooth, engaging visual effect.diff --git a/content/docs/components/neon-gradient-card.mdx b/content/docs/components/neon-gradient-card.mdxindex 7af1a8f9..a547a43c 100644--- a/content/docs/components/neon-gradient-card.mdx+++ b/content/docs/components/neon-gradient-card.mdx@@ -66,13 +66,13 @@ module.exports = {## Props-| Prop | Type | Description | Default |-| ------------ | --------- | --------------------------------------------- | --------------------------------------------------- |-| className | string | The class name to be applied to the component | - |-| children | ReactNode | Children elements | - |-| borderSize | number | The size of the border | 5 |-| borderRadius | number | The size of the radius | 20 |-| neonColors | object | The colors of the neon gradient | `{ firstColor: "#ff00aa", secondColor: "#00FFF1" }` |+| Prop | Type | Default | Description |+| -------------- | ----------- | --------------------------------------------------- | --------------------------------------------- |+| `className` | `string` | `-` | The class name to be applied to the component |+| `children` | `ReactNode` | `-` | Children elements |+| `borderSize` | `number` | `5` | The size of the border |+| `borderRadius` | `number` | `20` | The size of the radius |+| `neonColors` | `object` | `{ firstColor: "#ff00aa", secondColor: "#00FFF1" }` | The colors of the neon gradient |## Creditsdiff --git a/content/docs/components/number-ticker.mdx b/content/docs/components/number-ticker.mdxindex 90d6c4d8..96b8b06c 100644--- a/content/docs/components/number-ticker.mdx+++ b/content/docs/components/number-ticker.mdx@@ -49,9 +49,9 @@ npx shadcn@latest add "https://magicui.design/r/number-ticker"## Props-| Prop | Type | Description | Default |-| ------------- | ---------- | ------------------------------------ | ------- |-| value | int | The value to count to | 0 |-| direction | up \| down | The direction to count in | up |-| delay | number | The delay before counting | 0 |-| decimalPlaces | number | The number of decimal places to show | 0 |+| Prop | Type | Default | Description |+| --------------- | ------------ | ------- | ------------------------------------ |+| `value` | `int` | `0` | The value to count to |+| `direction` | `up \| down` | `"up"` | The direction to count in |+| `delay` | `number` | `0` | The delay before counting |+| `decimalPlaces` | `number` | `0` | The number of decimal places to show |diff --git a/content/docs/components/orbiting-circles.mdx b/content/docs/components/orbiting-circles.mdxindex abcce29e..eb194454 100644--- a/content/docs/components/orbiting-circles.mdx+++ b/content/docs/components/orbiting-circles.mdx@@ -72,14 +72,14 @@ module.exports = {## Props-| Prop | Type | Description | Default |-| --------- | --------------- | ------------------------------------------------ | ------- |-| className | string | The class name for the component | "" |-| children | React.ReactNode | The children nodes of the component | null |-| reverse | boolean | If true, the animation plays in reverse | false |-| duration | number | The duration of the animation in seconds | 20 |-| delay | number | The delay before the animation starts in seconds | 10 |-| radius | number | The radius of the orbit in pixels | 160 |-| path | boolean | If true, a path is displayed for the orbit | true |-| iconSize | number | The size of the icon in pixels | 30 |-| speed | number | The speed of the animation | 1 |+| Prop | Type | Default | Description |+| ----------- | ----------------- | ------- | ------------------------------------------------ |+| `className` | `string` | `-` | The class name for the component |+| `children` | `React.ReactNode` | `-` | The children nodes of the component |+| `reverse` | `boolean` | `false` | If true, the animation plays in reverse |+| `duration` | `number` | `20` | The duration of the animation in seconds |+| `delay` | `number` | `10` | The delay before the animation starts in seconds |+| `radius` | `number` | `160` | The radius of the orbit in pixels |+| `path` | `boolean` | `true` | If true, a path is displayed for the orbit |+| `iconSize` | `number` | `30` | The size of the icon in pixels |+| `speed` | `number` | `1` | The speed of the animation |diff --git a/content/docs/components/particles.mdx b/content/docs/components/particles.mdxindex 7ff3bb43..d932ce65 100644--- a/content/docs/components/particles.mdx+++ b/content/docs/components/particles.mdx@@ -42,14 +42,14 @@ npx shadcn@latest add "https://magicui.design/r/particles"## Props-| Prop | Type | Description | Default |-| --------- | ------- | -------------------------------- | ------- |-| className | string | The class name for the component | - |-| quantity | number | The number of particles | 100 |-| staticity | number | The staticity of the particles | 50 |-| ease | number | The ease of the particles | 50 |-| size | number | The size of the particles | 0.4 |-| refresh | boolean | Whether to refresh the particles | false |-| color | string | The color of the particles | #ffffff |-| vx | number | The x velocity of the particles | 0 |-| vy | number | The y velocity of the particles | 0 |+| Prop | Type | Default | Description |+| ----------- | --------- | --------- | -------------------------------- |+| `className` | `string` | `-` | The class name for the component |+| `quantity` | `number` | `100` | The number of particles |+| `staticity` | `number` | `50` | The staticity of the particles |+| `ease` | `number` | `50` | The ease of the particles |+| `size` | `number` | `0.4` | The size of the particles |+| `refresh` | `boolean` | `false` | Whether to refresh the particles |+| `color` | `string` | `#ffffff` | The color of the particles |+| `vx` | `number` | `0` | The x velocity of the particles |+| `vy` | `number` | `0` | The y velocity of the particles |diff --git a/content/docs/components/pulsating-button.mdx b/content/docs/components/pulsating-button.mdxindex 447c57e0..d94714cd 100644--- a/content/docs/components/pulsating-button.mdx+++ b/content/docs/components/pulsating-button.mdx@@ -65,12 +65,12 @@ module.exports = {## Props-| Prop | Type | Description |-| ---------- | --------------- | -------------------------------------------------------- |-| children | React.ReactNode | The content of the button. |-| className | string | Additional class names for the button. |-| pulseColor | string | The rbg numbers only for the color of the pulsing waves. |-| duration | string | The time span of one pulse. |+| Prop | Type | Default | Description |+| ------------ | ----------------- | ------- | -------------------------------------------------------- |+| `children` | `React.ReactNode` | `-` | The content of the button. |+| `className` | `string` | `-` | Additional class names for the button. |+| `pulseColor` | `string` | `-` | The rbg numbers only for the color of the pulsing waves. |+| `duration` | `string` | `-` | The time span of one pulse. |## Creditsdiff --git a/content/docs/components/rainbow-button.mdx b/content/docs/components/rainbow-button.mdxindex 6d40caba..a49c1765 100644--- a/content/docs/components/rainbow-button.mdx+++ b/content/docs/components/rainbow-button.mdx@@ -86,7 +86,7 @@ module.exports = {## Props-| Prop | Type | Description |-| --------- | --------------- | --------------------------------------------------- |-| children | React.ReactNode | The content to be displayed inside the button. |-| className | string | Additional CSS classes to be applied to the button. |+| Prop | Type | Default | Description |+| ----------- | ----------------- | ------- | --------------------------------------------------- |+| `children` | `React.ReactNode` | `-` | The content to be displayed inside the button. |+| `className` | `string` | `-` | Additional CSS classes to be applied to the button. |diff --git a/content/docs/components/retro-grid.mdx b/content/docs/components/retro-grid.mdxindex 08f01d83..39f06d78 100644--- a/content/docs/components/retro-grid.mdx+++ b/content/docs/components/retro-grid.mdx@@ -66,11 +66,11 @@ module.exports = {## Props-| Prop | Type | Description | Default |-| -------------- | ------ | --------------------------------------------- | ------- |-| className | string | Additional CSS classes for the grid container | "" |-| angle | number | Rotation angle of the grid in degrees | 65 |-| cellSize | number | Grid cell size in pixels | 60 |-| opacity | number | Grid opacity value between 0 and 1 | 0.5 |-| lightLineColor | string | Grid line color in light mode | "gray" |-| darkLineColor | string | Grid line color in dark mode | "gray" |+| Prop | Type | Default | Description |+| ---------------- | -------- | -------- | --------------------------------------------- |+| `className` | `string` | `-` | Additional CSS classes for the grid container |+| `angle` | `number` | `65` | Rotation angle of the grid in degrees |+| `cellSize` | `number` | `60` | Grid cell size in pixels |+| `opacity` | `number` | `0.5` | Grid opacity value between 0 and 1 |+| `lightLineColor` | `string` | `"gray"` | Grid line color in light mode |+| `darkLineColor` | `string` | `"gray"` | Grid line color in dark mode |diff --git a/content/docs/components/ripple-button.mdx b/content/docs/components/ripple-button.mdxindex 4ad54e4f..ea25b9c8 100644--- a/content/docs/components/ripple-button.mdx+++ b/content/docs/components/ripple-button.mdx@@ -71,12 +71,12 @@ module.exports = {## Props-| Prop | Type | Description |-| ----------- | --------------- | --------------------------------------------------------- |-| children | React.ReactNode | The content of the button. |-| className | string | Additional class names for the button. |-| rippleColor | string | The rbg numbers only for the color of the rippling waves. |-| duration | string | The time span of one ripple. |+| Prop | Type | Default | Description |+| ------------- | ----------------- | ------- | --------------------------------------------------------- |+| `children` | `React.ReactNode` | `-` | The content of the button. |+| `className` | `string` | `-` | Additional class names for the button. |+| `rippleColor` | `string` | `-` | The rbg numbers only for the color of the rippling waves. |+| `duration` | `string` | `-` | The time span of one ripple. |## Creditsdiff --git a/content/docs/components/ripple.mdx b/content/docs/components/ripple.mdxindex 966354de..02fa9c1a 100644--- a/content/docs/components/ripple.mdx+++ b/content/docs/components/ripple.mdx@@ -70,8 +70,8 @@ module.exports = {## Props-| Prop | Type | Default | Description |-| ----------------- | ------ | ------- | -------------------------------------- |-| mainCircleSize | number | 210 | The size of the main circle in pixels |-| mainCircleOpacity | number | 0.24 | The opacity of the main circle |-| numCircles | number | 8 | The number of ripple circles to render |+| Prop | Type | Default | Description |+| ------------------- | -------- | ------- | -------------------------------------- |+| `mainCircleSize` | `number` | `210` | The size of the main circle in pixels |+| `mainCircleOpacity` | `number` | `0.24` | The opacity of the main circle |+| `numCircles` | `number` | `8` | The number of ripple circles to render |diff --git a/content/docs/components/safari.mdx b/content/docs/components/safari.mdxindex 85a304a0..3403a463 100644--- a/content/docs/components/safari.mdx+++ b/content/docs/components/safari.mdx@@ -52,12 +52,12 @@ npx shadcn@latest add "https://magicui.design/r/safari"## Props-| Prop | Type | Description | Default |-| -------- | ------ | ----------------------------------------------------------- | ------- |-| url | string | The URL to display in the Safari address bar | - |-| imageSrc | string | The source URL of the image to display in the Safari window | - |-| videoSrc | string | The source URL of the video to display in the Safari window | - |-| width | number | The width of the Safari window | 1203 |-| height | number | The height of the Safari window | 753 |+| Prop | Type | Default | Description |+| ---------- | -------- | ------- | ----------------------------------------------------------- |+| `url` | `string` | `-` | The URL to display in the Safari address bar |+| `imageSrc` | `string` | `-` | The source URL of the image to display in the Safari window |+| `videoSrc` | `string` | `-` | The source URL of the video to display in the Safari window |+| `width` | `number` | `1203` | The width of the Safari window |+| `height` | `number` | `753` | The height of the Safari window |The `Safari` component also accepts all properties of the `SVGElement` type.diff --git a/content/docs/components/scratch-to-reveal.mdx b/content/docs/components/scratch-to-reveal.mdxindex 80e16184..851f868f 100644--- a/content/docs/components/scratch-to-reveal.mdx+++ b/content/docs/components/scratch-to-reveal.mdx@@ -40,15 +40,15 @@ npx shadcn@latest add "https://magicui.design/r/scratch-to-reveal"## Props-| Prop | Type | Default | Description |-| -------------------- | -------- | ------- | --------------------------------------------------------------------------------------------- |-| className | string | | The class name to apply to the component. |-| width | number | | Width of the scratch container. |-| height | number | | Height of the scratch container. |-| minScratchPercentage | number | 50 | Minimum percentage of scratched area to be considered as completed (Value between 0 and 100). |-| children | node | | The content to display in the marquee. |-| onCompete | function | | Callback function called when scratch is completed |-| gradientColors | string[] | | Gradient colors for the scratch effect. |+| Prop | Type | Default | Description |+| ---------------------- | ---------- | ------- | --------------------------------------------------------------------------------------------- |+| `className` | `string` | `-` | The class name to apply to the component. |+| `width` | `number` | `-` | Width of the scratch container. |+| `height` | `number` | `-` | Height of the scratch container. |+| `minScratchPercentage` | `number` | `50` | Minimum percentage of scratched area to be considered as completed (Value between 0 and 100). |+| `children` | `node` | `-` | The content to display in the marquee. |+| `onCompete` | `function` | `-` | Callback function called when scratch is completed |+| `gradientColors` | `string[]` | `-` | Gradient colors for the scratch effect. |## Creditsdiff --git a/content/docs/components/script-copy-btn.mdx b/content/docs/components/script-copy-btn.mdxindex ab544493..c91a0aa7 100644--- a/content/docs/components/script-copy-btn.mdx+++ b/content/docs/components/script-copy-btn.mdx@@ -40,11 +40,11 @@ npx shadcn@latest add "https://magicui.design/r/script-copy-btn"## Props-| Prop | Type | Description | Default |-| -------------------------- | ------------------------ | ----------------------------------------------------------- | ------- |-| className | string | The class name to be applied to the component | |-| showMultiplePackageOptions | boolean | Whether to show options for multiple package managers | true |-| codeLanguage | string | The language of the code snippet (e.g., "shell") | |-| lightTheme | string | The theme to use for light mode | |-| darkTheme | string | The theme to use for dark mode | |-| commandMap | Record \<string, string> | A map of package manager names to their respective commands | |+| Prop | Type | Default | Description |+| ---------------------------- | ------------------------ | ------- | ----------------------------------------------------------- |+| `className` | `string` | `-` | The class name to be applied to the component |+| `showMultiplePackageOptions` | `boolean` | `true` | Whether to show options for multiple package managers |+| `codeLanguage` | `string` | `-` | The language of the code snippet (e.g., "shell") |+| `lightTheme` | `string` | `-` | The theme to use for light mode |+| `darkTheme` | `string` | `-` | The theme to use for dark mode |+| `commandMap` | `Record<string, string>` | `-` | A map of package manager names to their respective commands |diff --git a/content/docs/components/scroll-based-velocity.mdx b/content/docs/components/scroll-based-velocity.mdxindex 6031dabe..b8285da3 100644--- a/content/docs/components/scroll-based-velocity.mdx+++ b/content/docs/components/scroll-based-velocity.mdx@@ -48,9 +48,9 @@ npm install motion## Props-| Prop | Type | Description | Default |-| --------------- | --------- | --------------------------------------------- | ------- |-| className | string | The class name to be applied to the component | |-| children | ReactNode | Content to be animated | |-| defaultVelocity | number | Base scroll velocity of text | 5 |-| numRows | number | Number of rows to be animated | 2 |+| Prop | Type | Default | Description |+| ----------------- | ----------- | ------- | --------------------------------------------- |+| `className` | `string` | `-` | The class name to be applied to the component |+| `children` | `ReactNode` | `-` | Content to be animated |+| `defaultVelocity` | `number` | `5` | Base scroll velocity of text |+| `numRows` | `number` | `2` | Number of rows to be animated |diff --git a/content/docs/components/scroll-progress.mdx b/content/docs/components/scroll-progress.mdxindex c7bd85af..22087413 100644--- a/content/docs/components/scroll-progress.mdx+++ b/content/docs/components/scroll-progress.mdx@@ -39,9 +39,9 @@ npx shadcn@latest add "https://magicui.design/r/scroll-progress"## Props-| Prop | Type | Description | Default |-| --------- | ------ | --------------------------------------------- | ------- |-| className | string | The class name to be applied to the component | - |+| Prop | Type | Default | Description |+| ----------- | -------- | ------- | --------------------------------------------- |+| `className` | `string` | `-` | The class name to be applied to the component |The `ScrollProgress` component also accepts all properties of the `HTMLDivElement` type.diff --git a/content/docs/components/shimmer-button.mdx b/content/docs/components/shimmer-button.mdxindex 81bb57fb..83c11d2a 100644--- a/content/docs/components/shimmer-button.mdx+++ b/content/docs/components/shimmer-button.mdx@@ -83,15 +83,15 @@ module.exports = {## Props-| Prop Name | Type | Description | Default Value |-| --------------- | --------------- | ----------------------------------- | ---------------- |-| shimmerColor | string | The color of the shimmer | #ffffff |-| shimmerSize | string | The size of the shimmer | 0.05em |-| borderRadius | string | The border radius of the button | 100px |-| shimmerDuration | string | The duration of the spark animation | 3s |-| background | string | The background of the button | rgba(0, 0, 0, 1) |-| className | string | The class name of the button | undefined |-| children | React.ReactNode | The children of the button | undefined |+| Prop | Type | Default | Description |+| ----------------- | ----------------- | ------------------ | ----------------------------------- |+| `shimmerColor` | `string` | `#ffffff` | The color of the shimmer |+| `shimmerSize` | `string` | `0.05em` | The size of the shimmer |+| `borderRadius` | `string` | `100px` | The border radius of the button |+| `shimmerDuration` | `string` | `3s` | The duration of the spark animation |+| `background` | `string` | `rgba(0, 0, 0, 1)` | The background of the button |+| `className` | `string` | `undefined` | The class name of the button |+| `children` | `React.ReactNode` | `undefined` | The children of the button |## Creditsdiff --git a/content/docs/components/shine-border.mdx b/content/docs/components/shine-border.mdxindex 8b7affe1..ecaffc75 100644--- a/content/docs/components/shine-border.mdx+++ b/content/docs/components/shine-border.mdx@@ -78,14 +78,14 @@ module.exports = {## Props-| Prop | Type | Description | Default |-| ------------ | --------- | ------------------------------------------------------------------- | ---------- |-| className | string | The class name to be applied to the component. | |-| duration | number | Defines the animation duration to be applied on the shining border. | 14 seconds |-| color | string | Defines the color of the border. | #FFFFFF |-| borderRadius | number | Defines the radius of the border. | 8px |-| borderWidth | number | Defines the width of the border. | 1px |-| children | ReactNode | Contains react node elements. | {} |+| Prop | Type | Default | Description |+| -------------- | ----------- | --------- | ------------------------------------------------------------------- |+| `className` | `string` | `-` | The class name to be applied to the component. |+| `duration` | `number` | `14` | Defines the animation duration to be applied on the shining border. |+| `color` | `string` | `#FFFFFF` | Defines the color of the border. |+| `borderRadius` | `number` | `8` | Defines the radius of the border. |+| `borderWidth` | `number` | `1` | Defines the width of the border. |+| `children` | `ReactNode` | `{}` | Contains react node elements. |## Creditsdiff --git a/content/docs/components/shiny-button.mdx b/content/docs/components/shiny-button.mdxindex b4ce7c05..a88a70a6 100644--- a/content/docs/components/shiny-button.mdx+++ b/content/docs/components/shiny-button.mdx@@ -42,10 +42,10 @@ npx shadcn@latest add "https://magicui.design/r/shiny-button"## Props-| Prop | Type | Description | Default |-| --------- | --------------- | --------------------------------------------- | ------- |-| className | string | The class name to be applied to the component | |-| children | React.ReactNode | The content to be displayed inside the button | |+| Prop | Type | Default | Description |+| ----------- | ----------------- | ------- | --------------------------------------------- |+| `className` | `string` | `-` | The class name to be applied to the component |+| `children` | `React.ReactNode` | `-` | The content to be displayed inside the button |## Creditsdiff --git a/content/docs/components/sparkles-text.mdx b/content/docs/components/sparkles-text.mdxindex 94004118..096875ab 100644--- a/content/docs/components/sparkles-text.mdx+++ b/content/docs/components/sparkles-text.mdx@@ -42,12 +42,12 @@ npx shadcn@latest add "https://magicui.design/r/sparkles-text"## Props-| Prop | Type | Description | Default |-| ------------- | ------ | -------------------------------------------------- | ---------------------------------------- |-| text | string | The text to display | - |-| className | string | The class name to be applied to the sparkles text. | - |-| sparklesCount | number | sparkles count that appears on the text | 10 |-| colors | object | the sparkles colors | `{first: '#A07CFE'; second: '#FE8FB5';}` |+| Prop | Type | Default | Description |+| --------------- | -------- | --------------------------------------- | -------------------------------------------------- |+| `text` | `string` | `-` | The text to display |+| `className` | `string` | `-` | The class name to be applied to the sparkles text. |+| `sparklesCount` | `number` | `10` | sparkles count that appears on the text |+| `colors` | `object` | `{first: '#A07CFE', second: '#FE8FB5'}` | the sparkles colors |## Creditsdiff --git a/content/docs/components/text-animate.mdx b/content/docs/components/text-animate.mdxindex a0033a54..a53b0a62 100644--- a/content/docs/components/text-animate.mdx+++ b/content/docs/components/text-animate.mdx@@ -64,14 +64,14 @@ npx shadcn@latest add "https://magicui.design/r/text-animate"## Props-| Prop | Type | Description | Default |-| ----------- | ----------------------------------------- | --------------------------------------------------------- | -------- |-| children | string | The text content to animate | |-| className | string | The class name to be applied to the component | |-| delay | number | Delay before animation starts | 0 |-| duration | number | Duration of the animation | 0.3 |-| variants | Variants | Custom motion variants for the animation | |-| as | ElementType | The element type to render | "p" |-| by | "text" \| "word" \| "character" \| "line" | How to split the text ("text", "word", "character") | "word" |-| startOnView | boolean | Whether to start animation when component enters viewport | true |-| animation | AnimationVariant | The animation preset to use | "fadeIn" |+| Prop | Type | Default | Description |+| ------------- | ------------------------------------------- | ---------- | --------------------------------------------------------- |+| `children` | `string` | `-` | The text content to animate |+| `className` | `string` | `-` | The class name to be applied to the component |+| `delay` | `number` | `0` | Delay before animation starts |+| `duration` | `number` | `0.3` | Duration of the animation |+| `variants` | `Variants` | `-` | Custom motion variants for the animation |+| `as` | `ElementType` | `"p"` | The element type to render |+| `by` | `"text" \| "word" \| "character" \| "line"` | `"word"` | How to split the text ("text", "word", "character") |+| `startOnView` | `boolean` | `true` | Whether to start animation when component enters viewport |+| `animation` | `AnimationVariant` | `"fadeIn"` | The animation preset to use |diff --git a/content/docs/components/text-reveal.mdx b/content/docs/components/text-reveal.mdxindex 5b1ab96c..fa9b2a36 100644--- a/content/docs/components/text-reveal.mdx+++ b/content/docs/components/text-reveal.mdx@@ -43,10 +43,10 @@ npx shadcn@latest add "https://magicui.design/r/text-reveal"## Props-| Prop | Type | Description | Default |-| --------- | ------ | -------------------------------------------- | ------- |-| className | string | The class name to be applied to the shimmer. | |-| text | string | The text to do the animation for | "" |+| Prop | Type | Default | Description |+| ----------- | -------- | ------- | -------------------------------------------- |+| `className` | `string` | `-` | The class name to be applied to the shimmer. |+| `text` | `string` | `-` | The text to do the animation for |## Creditsdiff --git a/content/docs/components/tweet-card.mdx b/content/docs/components/tweet-card.mdxindex ec619e14..ad0407f0 100644--- a/content/docs/components/tweet-card.mdx+++ b/content/docs/components/tweet-card.mdx@@ -69,15 +69,15 @@ export default function App() {### ClientTweetCard-| Prop | Type | Description |-| ---- | ------ | ------------------------------- |-| id | string | The id of the tweet to display. |+| Prop | Type | Default | Description |+| ---- | -------- | ------- | ------------------------------- |+| `id` | `string` | `-` | The id of the tweet to display. |### TweetCard-| Prop | Type | Description |-| ---- | ------ | ------------------------------- |-| id | string | The id of the tweet to display. |+| Prop | Type | Default | Description |+| ---- | -------- | ------- | ------------------------------- |+| `id` | `string` | `-` | The id of the tweet to display. |## Creditsdiff --git a/content/docs/components/typing-animation.mdx b/content/docs/components/typing-animation.mdxindex 90e731b9..ac95f94b 100644--- a/content/docs/components/typing-animation.mdx+++ b/content/docs/components/typing-animation.mdx@@ -42,11 +42,11 @@ npx shadcn@latest add "https://magicui.design/r/typing-animation"## Props-| Prop | Type | Description | Default |-| ----------- | ----------------- | --------------------------------------------- | ------- |-| children | string | Text content to animate | |-| className | string | The class name to be applied to the component | |-| duration | number | Duration to wait in between each char type | 100 |-| delay | number | Delay before animation starts (in ms) | 0 |-| as | React.ElementType | Component to render as | "div" |-| startOnView | boolean | Start animation when component is in view | false |+| Prop | Type | Default | Description |+| ------------- | ------------------- | ------- | --------------------------------------------- |+| `children` | `string` | `-` | Text content to animate |+| `className` | `string` | `-` | The class name to be applied to the component |+| `duration` | `number` | `100` | Duration to wait in between each char type |+| `delay` | `number` | `0` | Delay before animation starts (in ms) |+| `as` | `React.ElementType` | `"div"` | Component to render as |+| `startOnView` | `boolean` | `false` | Start animation when component is in view |diff --git a/content/docs/components/warp-background.mdx b/content/docs/components/warp-background.mdxindex 48a05763..bfc997ea 100644--- a/content/docs/components/warp-background.mdx+++ b/content/docs/components/warp-background.mdx@@ -42,13 +42,13 @@ npx shadcn@latest add "https://magicui.design/r/warp-background"## Props-| Prop | Type | Description | Default |-| ------------ | --------------- | ----------------------------------------------- | -------------------- |-| children | React.ReactNode | The content to be put inside the warp animation | - |-| perspective | number | The perspective of the warp animation | 100 |-| beamsPerSide | number | The number of beams per side | 3 |-| beamSize | number | The size of the beams | 5 |-| beamDelayMax | number | The maximum delay of the beams | 3 |-| beamDelayMin | number | The minimum delay of the beams | 0 |-| beamDuration | number | The duration of the beams | 3 |-| gridColor | string | The color of the grid lines | "hsl(var(--border))" |+| Prop | Type | Default | Description |+| -------------- | ----------------- | ---------------------- | ----------------------------------------------- |+| `children` | `React.ReactNode` | `-` | The content to be put inside the warp animation |+| `perspective` | `number` | `100` | The perspective of the warp animation |+| `beamsPerSide` | `number` | `3` | The number of beams per side |+| `beamSize` | `number` | `5` | The size of the beams |+| `beamDelayMax` | `number` | `3` | The maximum delay of the beams |+| `beamDelayMin` | `number` | `0` | The minimum delay of the beams |+| `beamDuration` | `number` | `3` | The duration of the beams |+| `gridColor` | `string` | `"hsl(var(--border))"` | The color of the grid lines |diff --git a/content/docs/components/word-rotate.mdx b/content/docs/components/word-rotate.mdxindex 084a6079..10b476fb 100644--- a/content/docs/components/word-rotate.mdx+++ b/content/docs/components/word-rotate.mdx@@ -48,9 +48,9 @@ npm install motion## Props-| Prop | Type | Description | Default |-| ----------- | --------------- | --------------------------------------------- | ------- |-| className | string | The class name to be applied to the component | |-| duration | number | Duration of the animation | 2500 |-| words | string[] | An array of words to rotate through | "" |-| motionProps | HTMLMotionProps | An object containing motion animation props | {} |+| Prop | Type | Default | Description |+| ------------- | ----------------- | ------- | --------------------------------------------- |+| `className` | `string` | `-` | The class name to be applied to the component |+| `duration` | `number` | `2500` | Duration of the animation |+| `words` | `string[]` | `""` | An array of words to rotate through |+| `motionProps` | `HTMLMotionProps` | `{}` | An object containing motion animation props |