Skip to content

chore: fix test cases & clean up docs #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Lexpeartha merged 3 commits into from
Sep 12, 2022
Merged

chore: fix test cases & clean up docs #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8327ee
docs: update Icon code example to code group
Lexpeartha Sep 11, 2022
f0ba9fb
ci: add step to set up playwright
Lexpeartha Sep 12, 2022
58b497a
style: add playwright icon to ci.yml
Lexpeartha Sep 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- uses: actions/setup-node@v3
with:
node-version: 16
cache: "pnpm"
cache: 'pnpm'

- name: 📦 Install dependencies
run: pnpm install --frozen-lockfile
Expand All @@ -38,14 +38,17 @@ jobs:
- uses: actions/setup-node@v3
with:
node-version: 16
cache: "pnpm"
cache: 'pnpm'

- name: 📦 Install dependencies
run: pnpm install --frozen-lockfile

- name: 🚧 Set up project
run: pnpm dev:prepare

- name: 🎭 Set up playwright
run: pnpm playwright install

- name: 🧪 Test project
run: pnpm test -- --coverage

Expand Down
22 changes: 11 additions & 11 deletions docs/content/3.features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,18 @@ Currently component doesn't support grouped and chained animations. For that usa

## Icons

Icons are auto-imported from `ionicons/icons` by default, following the pattern of camel case naming with `ionicons` in front of the original icon name from the [official icons website](https://ionic.io/ionicons).
Icons are auto-imported from `ionicons/icons` by default, following the pattern of camel case naming with `ionicons` in front of the original icon name, that you can find on the [official ionicons website](https://ionic.io/ionicons).

For example, instead of this:
::code-group

```vue [Auto-imported icons]
<template>
<ion-icon :icon="ioniconsImage"></ion-icon>
<ion-icon :md="ioniconsSquareSharp" :ios="ioniconsTriangleOutline"></ion-icon>
</template>
```

```vue [component.vue]
```vue [Manual imports]
<script setup lang="ts">
import { image, squareSharp, triangleOutline } from 'ionicons/icons'
</script>
Expand All @@ -102,14 +109,7 @@ import { image, squareSharp, triangleOutline } from 'ionicons/icons'
</template>
```

You would write this:

```vue [component.vue]
<template>
<ion-icon :icon="ioniconsImage"></ion-icon>
<ion-icon :md="ioniconsSquareSharp" :ios="ioniconsTriangleOutline"></ion-icon>
</template>
```
::

You can opt-out of auto-importing by setting `integrations.icons` module options in your `nuxt.config.ts` to `false`.

Expand Down