ionic-framework/packages/vue/README.md

@ionic/vue

Ionic Framework integration for Vue 3 apps.

Building

1. Install dependencies in @ionic/core:

cd core && pnpm install

2. Build @ionic/core. This will generate Vue component bindings in the packages/vue directory:

pnpm build

Warning

If you are receiving errors about missing packages, you may need to run pnpm install --force to force the installation of the missing packages.

3. Install dependencies in @ionic/vue:

cd packages/vue && pnpm install

4. Build @ionic/vue:

pnpm build

Warning

If you are receiving errors about missing packages, you may need to run pnpm install --force to force the installation of the missing packages.

5. Install dependencies in @ionic/vue-router:

cd packages/vue-router && pnpm install

6. Build @ionic/vue-router:

pnpm build

Warning

If you are receiving errors about missing packages, you may need to run pnpm install --force to force the installation of the missing packages.

Tests

• E2E Tests are found in the packages/vue/test/base/tests directory and use Cypress.
• When making changes to @ionic/vue or @ionic/vue-router you can run pnpm build.watch in their root directories to ensure that the test application is using your latest changes. Be sure to build in the vue and vue-router directories first.
• Tests can be run in headless mode by running npm run cypress.
• If you want to open the Cypress test runner, you can run node_modules/.bin/cypress open.
• Bug fix and feature PRs should have new tests verifying the PR functionality.

Contributing

See our Contributing Guide.

Need Help?

Post your question on the Ionic Forum.