@formkit/pro - npm Package Compare versions

Comparing version 0.125.8 to 0.125.9

index.d.ts

		@@ -503,2 +503,3 @@ import type { AllReals } from '@formkit/inputs';
		input: FormKitSlotData<Props, CurrencySlotData<Props>>;
		label: FormKitSlotData<Props, CurrencySlotData<Props>>;
		prefix: FormKitSlotData<Props, CurrencySlotData<Props>>;
		@@ -505,0 +506,0 @@ suffix: FormKitSlotData<Props, CurrencySlotData<Props>>;

package.json

		{
		"name": "@formkit/pro",
		"version": "0.125.8",
		"version": "0.125.9",
		"description": "FormKit Pro — Form inputs and tools for high quality forms.",
		@@ -5,0 +5,0 @@ "main": "index.cjs",

README.md

		@@ -18,39 +18,24 @@ # FormKit Pro

		## Usage
		## Development

		To use FormKit Pro follow these steps:
		FormKit Pro has two development environments, a vite instance in the `examples` directory and a nuxt instance in `examples-nuxt`.

		1. Register for a free account at: https://formkit.com/pro
		2. Create a new project and copy the project key.
		3. Follow installation instructions for the pro package.
		To run vite `pnpm run dev`

		### Installation
		To run nuxt `pnpm run dev-nuxt`

		FormKit Pro is a FormKit plugin that is installed just like any other plugin. To configure FormKit Pro, import the `createProPlugin` from the `@formkit/pro` library. This function takes 2 arguments, your project key, and any pro inputs you want to use.
		## Testing

		```js
		// main.js
		import { createApp } from 'vue'
		import { plugin, defaultConfig } from '@formkit/vue'
		import { createProPlugin, autocomplete } from '@formkit/pro'
		import App from 'App.vue'
		FormKit Pro contains two testing frameworks: vitest and playwright. Tests are currently run against source code and not what is built.

		const pro = createProPlugin('{your-project-key}', {
		autocomplete,
		})
		To run vitests: `pnpm test`.

		const app = createApp(App)
		To run playwright tests (have a dev server pointing to port 3000) and in a separate terminal run `npx playwright test`.

		app.use(
		plugin,
		defaultConfig({
		plugins: [pro],
		})
		)
		```
		## CI

		## License
		FormKit Pro runs Vitests and playwright in Github actions when pushes or releases are made on either the `master` or `next` branch. When pushing to any other branch, only vitests are run in the CI.

		Although using FormKit Pro in production requires a paid license, you may use these these inputs for free during your entire development process. You will not be charged until after your project goes into production. For pricing details, please visit [formkit.com/pro](https://formkit.com/pro).
		## Publishing

		By using this software, you agree to the abide by the [included license](./LICENSE).
		In order to publish a new verison of FormKit Pro, use the command: `pnpm run publish`. `next` and `dev` tags can be published on any non-master branch. In order to publish, you must have the appropriate npm authToken in your `.npmrc`.

@formkit/pro - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics

Worsened metrics