@sbc-connect/nuxt-forms 0.1.3 → 0.1.5

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.
Files changed (3) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +24 -53
  3. package/package.json +8 -7
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @sbc-connect/nuxt-forms
2
2
 
3
+ ## 0.1.5
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies [[`4231254`](https://github.com/bcgov/connect-nuxt/commit/42312540f5eec65f5d3979d5492bdfaa9bb0b079)]:
8
+ - @sbc-connect/nuxt-base@0.1.5
9
+
10
+ ## 0.1.4
11
+
12
+ ### Patch Changes
13
+
14
+ - Updated dependencies [[`90f240f`](https://github.com/bcgov/connect-nuxt/commit/90f240fd789a5286ded5df710bddd6dc953bcba5), [`0fb8c54`](https://github.com/bcgov/connect-nuxt/commit/0fb8c54e059d78b246b80a03f049d075b7bbcf72), [`9b8c225`](https://github.com/bcgov/connect-nuxt/commit/9b8c225a011e3c89c9b490e93a554f55a4e29b78)]:
15
+ - @sbc-connect/nuxt-base@0.1.4
16
+
3
17
  ## 0.1.3
4
18
 
5
19
  ### Patch Changes
package/README.md CHANGED
@@ -1,73 +1,44 @@
1
- # Nuxt Layer Starter
1
+ [![License](https://img.shields.io/badge/License-BSD%203%20Clause-blue.svg)](LICENSE) [![pkg.pr.new](https://pkg.pr.new/badge/OWNER/REPO)](https://pkg.pr.new/~/bcgov/connect-nuxt)
2
2
 
3
- Create Nuxt extendable layer with this GitHub template.
3
+ # @sbc-connect/nuxt-forms
4
+ A Nuxt layer for building and managing complex forms within the Connect ecosystem.
4
5
 
5
- ## Setup
6
+ This package provides a library of reusable form components, integrated validation logic, and composables to standardize form creation and handling across all filings.
6
7
 
7
- Make sure to install the dependencies:
8
+ ## Features
8
9
 
9
- ```bash
10
- pnpm install
11
- ```
12
-
13
- ## Working on your layer
14
-
15
- Your layer is at the root of this repository, it is exactly like a regular Nuxt project, except you can publish it on NPM.
10
+ ### Form Management
11
+ - A comprehensive set of accessible, pre-styled form input components.
12
+ - Standardized validation schemas using Zod for consistent error handling.
16
13
 
17
- The `.playground` directory should help you on trying your layer during development.
14
+ ### Core Development Assets
15
+ - Pre-built components for common inputs like addresses, postal codes, names, emails and phone numbers.
16
+ - Reusable Zod schemas to manage the input validations.
18
17
 
19
- Running `pnpm dev` will prepare and boot `.playground` directory, which imports your layer itself.
18
+ For detailed usage and API documentation, please see the [Forms Layer Docs](../../../docs/packages/layers/forms/intro.md).
20
19
 
21
- ## Distributing your layer
20
+ ## Usage
22
21
 
23
- Your Nuxt layer is shaped exactly the same as any other Nuxt project, except you can publish it on NPM.
24
-
25
- To do so, you only have to check if `files` in `package.json` are valid, then run:
22
+ ### Install
26
23
 
27
24
  ```bash
28
- npm publish --access public
25
+ pnpm install @sbc-connect/nuxt-forms
29
26
  ```
30
27
 
31
- Once done, your users will only have to run:
28
+ ### Configure
29
+ Then add the dependency to `extends` in `nuxt.config`:
32
30
 
33
- ```bash
34
- npm install --save your-layer
35
- ```
36
-
37
- Then add the dependency to their `extends` in `nuxt.config`:
31
+ > [!NOTE]
32
+ > `@sbc-connect/nuxt-forms` already includes `@sbc-connect/nuxt-base`, it is not necessary to install `@sbc-connect/nuxt-base`.
38
33
 
39
34
  ```ts
40
35
  defineNuxtConfig({
41
- extends: 'your-layer'
36
+ extends: '@sbc-connect/nuxt-forms'
42
37
  })
43
38
  ```
44
39
 
45
- ## Development Server
46
-
47
- Start the development server on http://localhost:3000
48
-
49
- ```bash
50
- pnpm dev
51
- ```
52
-
53
- ## Production
54
-
55
- Build the application for production:
56
-
57
- ```bash
58
- pnpm build
59
- ```
60
-
61
- Or statically generate it with:
62
-
63
- ```bash
64
- pnpm generate
65
- ```
66
-
67
- Locally preview production build:
68
-
69
- ```bash
70
- pnpm preview
71
- ```
40
+ ## Environment Variables
41
+ This layer does not require any specific environment variables to be set.
72
42
 
73
- Checkout the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
43
+ ## Contributing
44
+ We welcome contributions to this package! Please see the main [suspicious link removed] for information on our branching strategy, commit conventions, and pull request process.
package/package.json CHANGED
@@ -1,22 +1,23 @@
1
1
  {
2
2
  "name": "@sbc-connect/nuxt-forms",
3
3
  "type": "module",
4
- "version": "0.1.3",
4
+ "version": "0.1.5",
5
5
  "repository": "github:bcgov/connect-nuxt",
6
+ "license": "BSD-3-Clause",
6
7
  "main": "./nuxt.config.ts",
7
8
  "devDependencies": {
8
9
  "@axe-core/playwright": "^4.10.2",
9
- "@vitest/coverage-v8": "^3.2.3",
10
+ "@vitest/coverage-v8": "^3.2.4",
10
11
  "dotenv": "^17.2.0",
11
- "nuxt": "4.0.0",
12
+ "nuxt": "^4.0.0",
12
13
  "typescript": "^5.8.3",
13
- "vue-tsc": "^3.0.2",
14
+ "vue-tsc": "^3.0.3",
14
15
  "@sbc-connect/playwright-config": "0.0.4",
15
- "@sbc-connect/eslint-config": "0.0.4",
16
- "@sbc-connect/vitest-config": "0.0.4"
16
+ "@sbc-connect/vitest-config": "0.0.5",
17
+ "@sbc-connect/eslint-config": "0.0.5"
17
18
  },
18
19
  "dependencies": {
19
- "@sbc-connect/nuxt-base": "0.1.3"
20
+ "@sbc-connect/nuxt-base": "0.1.5"
20
21
  },
21
22
  "scripts": {
22
23
  "preinstall": "npx only-allow pnpm",