@formkit/pro 0.125.8 → 0.125.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -27
- package/index.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,41 +15,26 @@ FormKit Pro is a first party library of professional grade "synthetic" inputs fo
|
|
|
15
15
|
- Toggle
|
|
16
16
|
- Transfer List
|
|
17
17
|
|
|
18
|
-
##
|
|
18
|
+
## Development
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
FormKit Pro has two development environments, a vite instance in the `examples` directory and a nuxt instance in `examples-nuxt`.
|
|
21
21
|
|
|
22
|
-
|
|
23
|
-
2. Create a new project and copy the project key.
|
|
24
|
-
3. Follow installation instructions for the pro package.
|
|
22
|
+
To run vite `pnpm run dev`
|
|
25
23
|
|
|
26
|
-
|
|
24
|
+
To run nuxt `pnpm run dev-nuxt`
|
|
27
25
|
|
|
28
|
-
|
|
26
|
+
## Testing
|
|
29
27
|
|
|
30
|
-
|
|
31
|
-
// main.js
|
|
32
|
-
import { createApp } from 'vue'
|
|
33
|
-
import { plugin, defaultConfig } from '@formkit/vue'
|
|
34
|
-
import { createProPlugin, autocomplete } from '@formkit/pro'
|
|
35
|
-
import App from 'App.vue'
|
|
28
|
+
FormKit Pro contains two testing frameworks: vitest and playwright. Tests are currently run against source code and not what is built.
|
|
36
29
|
|
|
37
|
-
|
|
38
|
-
autocomplete,
|
|
39
|
-
})
|
|
30
|
+
To run vitests: `pnpm test`.
|
|
40
31
|
|
|
41
|
-
|
|
32
|
+
To run playwright tests (have a dev server pointing to port 3000) and in a separate terminal run `npx playwright test`.
|
|
42
33
|
|
|
43
|
-
|
|
44
|
-
plugin,
|
|
45
|
-
defaultConfig({
|
|
46
|
-
plugins: [pro],
|
|
47
|
-
})
|
|
48
|
-
)
|
|
49
|
-
```
|
|
34
|
+
## CI
|
|
50
35
|
|
|
51
|
-
|
|
36
|
+
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.
|
|
52
37
|
|
|
53
|
-
|
|
38
|
+
## Publishing
|
|
54
39
|
|
|
55
|
-
|
|
40
|
+
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`.
|
package/index.d.ts
CHANGED
|
@@ -500,6 +500,7 @@ export declare interface FormKitColorpickerSlots<Props extends FormKitInputs<Pro
|
|
|
500
500
|
export declare interface FormKitCurrencySlots<Props extends FormKitInputs<Props>> {
|
|
501
501
|
wrapper: FormKitSlotData<Props, CurrencySlotData<Props>>;
|
|
502
502
|
input: FormKitSlotData<Props, CurrencySlotData<Props>>;
|
|
503
|
+
label: FormKitSlotData<Props, CurrencySlotData<Props>>;
|
|
503
504
|
prefix: FormKitSlotData<Props, CurrencySlotData<Props>>;
|
|
504
505
|
suffix: FormKitSlotData<Props, CurrencySlotData<Props>>;
|
|
505
506
|
help: FormKitSlotData<Props, CurrencySlotData<Props>>;
|