UI Library for Design Engineers. Animated components and effects you can copy and paste into your apps. Free. Open Source.
docs: add JSDoc comment and fix markdown page of shine border component (#105)
Adebayo Anuoluwa Success14f7ecde008a
diff --git a/content/docs/components/shine-border.mdx b/content/docs/components/shine-border.mdxindex 89f7424e..9848a63f 100644--- a/content/docs/components/shine-border.mdx+++ b/content/docs/components/shine-border.mdx@@ -55,12 +55,12 @@ components/magicui/shine-border.tsx| Prop | Type | Description | Default || ------------ | ------------------------------ | --------------------------------------------------- | ---------- |-| className | string | The class name to be applied to the component | |-| duration | number | The class name to be applied to the shining border. | 14 seconds |-| color | `#${string}` OR `#${string}`[] | A string or string array to define border color. | #FFBD7A |+| 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}` OR `#${string}`[] | A string or string array to define border color. | #FFFFFF || borderRadius | number | Defines the radius of the border. | 8px |-| borderWidth | number | Defines the width of the border. | 2px |-| children | React.ReactNode | Contains react node elements. | {} |+| borderWidth | number | Defines the width of the border. | 1px |+| children | ReactNode | Contains react node elements. | {} |## Creditsdiff --git a/registry/components/magicui/shine-border.tsx b/registry/components/magicui/shine-border.tsxindex 3626e349..2589398b 100644--- a/registry/components/magicui/shine-border.tsx+++ b/registry/components/magicui/shine-border.tsx@@ -12,6 +12,16 @@ interface ShineBorderProps {children: React.ReactNode;}+/**+ * @name Shine Border+ * @description It is an animated background border effect component with easy to use and configurable props.+ * @param borderRadius defines the radius of the border.+ * @param borderWidth defines the width of the border.+ * @param duration defines the animation duration to be applied on the shining border+ * @param color a string or string array to define border color.+ * @param className defines the class name to be applied to the component+ * @param children contains react node elements.+ */export default function ShineBorder({borderRadius = 8,borderWidth = 1,