Skip to content

Commit

Permalink
docs: minor fixes & badge docs updates (jd-solanki#120)
Browse files Browse the repository at this point in the history
Co-authored-by: JD Solanki <47495003+jd-solanki@users.noreply.github.com>
  • Loading branch information
ManUtopiK and jd-solanki committed Jan 18, 2023
1 parent 09cd007 commit a11c4bc
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 26 deletions.
4 changes: 1 addition & 3 deletions docs/components/demos/card/DemoCardVariants.vue
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@
variant="light"
color="primary"
class="shadow-none"
>
<p>Awesome</p>
</ACard>
/>

<!-- 馃憠 Outline -->
<ACard
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/components/alert.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script lang="ts" setup>
import api from '@anu/component-meta/AAlert.json';
import api from '@anu/component-meta/AAlert.json'
</script>

# Alert
Expand Down Expand Up @@ -42,7 +42,7 @@ You can use `variant="outline"` to create outlined alert.
<!-- 馃憠 Icons -->
::::card Icons

You can use `icon` prop to render icon in button.
You can use `icon` prop to render icon in alert.

Use `append-icon` prop to render icon after default slot.

Expand Down
10 changes: 5 additions & 5 deletions docs/guide/components/avatar.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script lang="ts" setup>
import api from '@anu/component-meta/AAvatar.json';
import api from '@anu/component-meta/AAvatar.json'
</script>

# Avatar
Expand All @@ -20,7 +20,7 @@ Use `color` prop to change the avatar color.
<!-- 馃憠 Fill -->
::::card Fill

You can use `variant="fill"` to create avatar with filled background
You can use `variant="fill"` to create avatar with filled background.

:::code DemoAvatarFill
<<< @/components/demos/avatar/DemoAvatarFill.vue{4,9,15}
Expand All @@ -30,7 +30,7 @@ You can use `variant="fill"` to create avatar with filled background
<!-- 馃憠 Outlined -->
::::card Outlined

You can use variant="outline" to create outlined avatar
You can use `variant="outline"` to create outlined avatar.

:::code DemoAvatarOutlined
<<< @/components/demos/avatar/DemoAvatarOutlined.vue{4,9,15}
Expand All @@ -41,7 +41,7 @@ You can use variant="outline" to create outlined avatar
<!-- 馃憠 Sizing -->
::::card Sizing

You can use font-size utility to adjust the size of avatar
You can use font-size utility to adjust the size of avatar.

:::code DemoAvatarSizing
<<< @/components/demos/avatar/DemoAvatarSizing.vue{5,9,13,17,21}
Expand All @@ -52,7 +52,7 @@ You can use font-size utility to adjust the size of avatar
<!-- 馃憠 Roundness -->
::::card Roundness

You can adjust avatar roundness using border-radius utilities
You can adjust avatar roundness using border-radius utilities.

:::code DemoAvatarRoundness
<<< @/components/demos/avatar/DemoAvatarRoundness.vue{5,9,13,17,21}
Expand Down
14 changes: 7 additions & 7 deletions docs/guide/components/badge.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<script lang="ts" setup>
import api from '@anu/component-meta/ABadge.json';
import api from '@anu/component-meta/ABadge.json'
</script>

# Badge

<!-- 馃憠 Default -->
::::card Default

Default variant for badge is `standard`
Default color for badge is `primary`.

:::code DemoBadgeDefault
<<< @/components/demos/badge/DemoBadgeDefault.vue
Expand All @@ -18,7 +18,7 @@ Default variant for badge is `standard`
<!-- 馃憠 Content -->
::::card Content

Use the prop `content` to pass numeric values, if you want to use other data different than a number, use the slot `content` instead
Use the prop `content` to pass numeric values, if you want to use other data different than a number use the slot `content` instead.

:::code DemoBadgeContent
<<< @/components/demos/badge/DemoBadgeContent.vue{3,8}
Expand All @@ -29,7 +29,7 @@ Use the prop `content` to pass numeric values, if you want to use other data dif
<!-- 馃憠 v-model support -->
::::card v-model support

You can use v-model to control hiding/showing the badge
You can use v-model to control hiding/showing the badge.

:::code DemoBadgeVModel
<<< @/components/demos/badge/DemoBadgeVModel.vue{4,9}
Expand All @@ -51,7 +51,7 @@ You can use the `color` prop to change the badge color.
<!-- 馃憠 Dot -->
::::card Dot

Use the prop `variant` to transform the badge into a `dot`
Use the prop `dot` to transform the badge into a dot.

:::code DemoBadgeDot
<<< @/components/demos/badge/DemoBadgeDot.vue{3}
Expand All @@ -62,7 +62,7 @@ Use the prop `variant` to transform the badge into a `dot`
<!-- 馃憠 Anchor origin -->
::::card Anchor origin

Change the position of the badge by passing `horizontal` and `vertical` values to the `anchor` prop.
Change the position of the badge by passing `top/bottom` and `left/right` values to the `anchor` prop.

:::code DemoBadgeAnchor
<<< @/components/demos/badge/DemoBadgeAnchor.vue{5,11,17,23}
Expand All @@ -73,7 +73,7 @@ Change the position of the badge by passing `horizontal` and `vertical` values t
<!-- 馃憠 Max -->
::::card Max

Change the `max` prop to cap the numeric value of the content
Change the `max` prop to cap the numeric value of the content.

:::code DemoBadgeMax
<<< @/components/demos/badge/DemoBadgeMax.vue{5,11,17}
Expand Down
6 changes: 3 additions & 3 deletions docs/guide/components/rating.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<script lang="ts" setup>
import api from '@anu/component-meta/ARating.json';
import api from '@anu/component-meta/ARating.json'
</script>

# Rating

<!-- 馃憠 Basic -->
::::card Basic

Rating component allows users to rate content
Rating component allows users to rate content.

:::code DemoRatingBasic
<<< @/components/demos/rating/DemoRatingBasic.vue{4,8}
Expand All @@ -18,7 +18,7 @@ Rating component allows users to rate content
<!-- 馃憠 Colors -->
::::card Colors

You can use `color` prop to change the rating color
You can use `color` prop to change the rating color.

:::code DemoRatingColor
<<< @/components/demos/rating/DemoRatingColor.vue{10}
Expand Down
12 changes: 6 additions & 6 deletions docs/guide/components/switch.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script lang="ts" setup>
import api from '@anu/component-meta/ASwitch.json';
import api from '@anu/component-meta/ASwitch.json'
</script>

# Switch
Expand All @@ -18,7 +18,7 @@ Use `ASwitch` component to create toggle for boolean value.
<!-- 馃憠 Colors -->
::::card Colors

You can use `color` prop to change the switch color
You can use `color` prop to change the switch color.

:::code DemoSwitchColors
<<< @/components/demos/switch/DemoSwitchColors.vue{15,19,23,27,31}
Expand All @@ -42,7 +42,7 @@ Label and switch have `justify-between` added as this is how generally used but
::::

:::tip
You can also use default slot to render the label
You can also use default slot to render the label.
:::

<!-- 馃憠 Icons -->
Expand All @@ -59,7 +59,7 @@ Use `on-icon` & `off-icon` prop to render icons inside switch dot.
<!-- 馃憠 Sizing -->
::::card Sizing

You can use font-size utility to adjust the size of switch
You can use font-size utility to adjust the size of switch.

:::code DemoSwitchSizing
<<< @/components/demos/switch/DemoSwitchSizing.vue{16,20,25,29,33}
Expand All @@ -70,7 +70,7 @@ You can use font-size utility to adjust the size of switch
<!-- 馃憠 States -->
::::card States

You can use `disabled` prop to disable the switch
You can use `disabled` prop to disable the switch.

:::code DemoSwitchStates
<<< @/components/demos/switch/DemoSwitchStates.vue{23,28}
Expand All @@ -81,7 +81,7 @@ You can use `disabled` prop to disable the switch
<!-- 馃憠 Roundness -->
::::card Roundness

You can adjust switch roundness using border-radius utilities
You can adjust switch roundness using border-radius utilities.

:::code DemoSwitchRoundness
<<< @/components/demos/switch/DemoSwitchRoundness.vue{12,16}
Expand Down

0 comments on commit a11c4bc

Please sign in to comment.