From e4db658745c6a18ce2afd60bf413c2df6d9e7df7 Mon Sep 17 00:00:00 2001 From: Prashanth HN Date: Fri, 16 Sep 2022 09:44:00 +0530 Subject: [PATCH] Updates to Documentation (#103) * Update documentation for Badge, Card & List * Improved docs for NativeSelect & TextArea Co-authored-by: Prashanth HN --- docs/docs/components/badge.mdx | 10 ++++---- docs/docs/components/card.mdx | 35 ++++++++++++--------------- docs/docs/components/list.mdx | 2 +- docs/docs/components/nativeSelect.mdx | 5 +--- docs/docs/components/text-area.mdx | 4 +-- 5 files changed, 25 insertions(+), 31 deletions(-) diff --git a/docs/docs/components/badge.mdx b/docs/docs/components/badge.mdx index af0d9cf..752502f 100644 --- a/docs/docs/components/badge.mdx +++ b/docs/docs/components/badge.mdx @@ -68,14 +68,14 @@ import { Badge } from "@hover-design/react"; ```jsx
- +
```
- +
@@ -86,17 +86,17 @@ import { Badge } from "@hover-design/react"; - ```
- -
diff --git a/docs/docs/components/card.mdx b/docs/docs/components/card.mdx index e4dfd76..e2fa6c8 100644 --- a/docs/docs/components/card.mdx +++ b/docs/docs/components/card.mdx @@ -16,75 +16,72 @@ import { Card } from "@hover-design/react"; import "@hover-design/react/dist/style.css"; import { Card } from "@hover-design/react"; -export const CardComponent = ({ variant, children }) => ( - {children} -); ```jsx
- +

I am a card heading

I am card Content

-
+
``` - +

I am a card heading

I am card Content

-
+ ##### Card Outline ```jsx
- +

I am a card heading

I am card Content

-
+
``` - +

I am a card heading

I am card Content

-
+ ##### Card Solid ```jsx - +

I am a card heading

I am card Content

-
+ ``` - +

I am a card heading

I am card Content

-
+ ##### Card Shadow ```jsx - +

I am a card heading

I am card Content

-
+ ``` - +

I am a card heading

I am card Content

-
+ ### Props Referece diff --git a/docs/docs/components/list.mdx b/docs/docs/components/list.mdx index ece1eac..ff36113 100644 --- a/docs/docs/components/list.mdx +++ b/docs/docs/components/list.mdx @@ -98,5 +98,5 @@ export const ListItemComp = ({ variant, children }) => ( | Attributes | Values | Optional ? | | :--------- | :-------------------------------------------------------------------------------------------------------------------------------: | ---------: | | variant | `horizontal` | `vertical` | Yes | -| type | `square` | `circle` | `\1F44D` | [listStyleType](https://developer.mozilla.org/en-US/docs/Web/CSS/list-style-type) | Yes | +| type | `square` | `circle` | [`\1F44D`](https://www.w3schools.com/charsets/ref_emoji.asp) | [listStyleType](https://developer.mozilla.org/en-US/docs/Web/CSS/list-style-type) | Yes | | children | React.Children | Yes | diff --git a/docs/docs/components/nativeSelect.mdx b/docs/docs/components/nativeSelect.mdx index 0eb3e12..298f366 100644 --- a/docs/docs/components/nativeSelect.mdx +++ b/docs/docs/components/nativeSelect.mdx @@ -123,15 +123,12 @@ const options = [
; ``` -> Note: **error** can also be passed as a boolean. - + ``` - + ### Rows & Cols