@wwtdev/bsds-components-vue3 0.0.3 → 0.1.1

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 (5) hide show
  1. package/README.md +25 -5
  2. package/lib/components.d.ts +5 -0
  3. package/lib/components.js +39 -0
  4. package/lib/components.js.map +1 -1
  5. package/package.json +15 -3
package/README.md CHANGED
@@ -1,11 +1,31 @@
1
- # `components-vue3`
1
+ # BSDS Components for Vue 3
2
2
 
3
- > TODO: description
3
+ ## Installation
4
4
 
5
- ## Usage
5
+ ```bash
6
+ npm install --save @wwtdev/bsds-components-vue3
7
+ ```
8
+ ## Using the Components
9
+
10
+ Add the following to your `main.js` file to import and use the component library:
11
+
12
+ ```
13
+ import { ComponentLibrary } from '@wwtdev/bsds-components-vue3';
14
+ import '@wwtdev/bsds-components/www/build/components.css'
6
15
 
16
+ createApp(App).use(ComponentLibrary).mount('#app')
7
17
  ```
8
- const componentsVue3 = require('components-vue3');
9
18
 
10
- // TODO: DEMONSTRATE API
19
+ Now you can use BSDS Components in your code, just like standard Vue components:
20
+
11
21
  ```
22
+ <script setup>
23
+ import { BsButton } from '@wwtdev/bsds-components-vue3'
24
+ </script>
25
+
26
+ <template>
27
+ <div>
28
+ <BsButton>Hello World!</BsButton>
29
+ </div>
30
+ </template>
31
+ ```
package/lib/components.d.ts CHANGED
@@ -1,2 +1,7 @@
1
1
  import type { JSX } from '@wwtdev/bsds-components';
2
2
  export declare const BsButton: import("vue").DefineComponent<JSX.BsButton & import("./vue-component-lib/utils").InputProps<string | number | boolean>, object, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<JSX.BsButton & import("./vue-component-lib/utils").InputProps<string | number | boolean>>, {}>;
3
+ export declare const BsField: import("vue").DefineComponent<JSX.BsField & import("./vue-component-lib/utils").InputProps<string | number | boolean>, object, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<JSX.BsField & import("./vue-component-lib/utils").InputProps<string | number | boolean>>, {}>;
4
+ export declare const BsHint: import("vue").DefineComponent<JSX.BsHint & import("./vue-component-lib/utils").InputProps<string | number | boolean>, object, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<JSX.BsHint & import("./vue-component-lib/utils").InputProps<string | number | boolean>>, {}>;
5
+ export declare const BsInput: import("vue").DefineComponent<JSX.BsInput & import("./vue-component-lib/utils").InputProps<string | number | boolean>, object, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<JSX.BsInput & import("./vue-component-lib/utils").InputProps<string | number | boolean>>, {}>;
6
+ export declare const BsInputField: import("vue").DefineComponent<JSX.BsInputField & import("./vue-component-lib/utils").InputProps<string | number | boolean>, object, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<JSX.BsInputField & import("./vue-component-lib/utils").InputProps<string | number | boolean>>, {}>;
7
+ export declare const BsLabel: import("vue").DefineComponent<JSX.BsLabel & import("./vue-component-lib/utils").InputProps<string | number | boolean>, object, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<JSX.BsLabel & import("./vue-component-lib/utils").InputProps<string | number | boolean>>, {}>;
package/lib/components.js CHANGED
@@ -8,4 +8,43 @@ export const BsButton = defineContainer('bs-button', undefined, [
8
8
  'textBtn',
9
9
  'size'
10
10
  ]);
11
+ export const BsField = defineContainer('bs-field', undefined, [
12
+ 'disabled',
13
+ 'error',
14
+ 'hints',
15
+ 'label',
16
+ 'labelFor',
17
+ 'required',
18
+ 'hintId'
19
+ ]);
20
+ export const BsHint = defineContainer('bs-hint', undefined, [
21
+ 'error',
22
+ 'hintId',
23
+ 'hints'
24
+ ]);
25
+ export const BsInput = defineContainer('bs-input', undefined, [
26
+ 'disabled',
27
+ 'error',
28
+ 'passAttrs',
29
+ 'required',
30
+ 'type',
31
+ 'value',
32
+ 'hintId'
33
+ ], 'value', 'input');
34
+ export const BsInputField = defineContainer('bs-input-field', undefined, [
35
+ 'disabled',
36
+ 'error',
37
+ 'hints',
38
+ 'label',
39
+ 'passAttrs',
40
+ 'required',
41
+ 'type',
42
+ 'value'
43
+ ], 'value', 'input');
44
+ export const BsLabel = defineContainer('bs-label', undefined, [
45
+ 'disabled',
46
+ 'for',
47
+ 'passAttrs',
48
+ 'required'
49
+ ]);
11
50
  //# sourceMappingURL=components.js.map
package/lib/components.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"components.js","sourceRoot":"","sources":["../src/components.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAO5D,MAAM,CAAC,MAAM,QAAQ,GAAiB,eAAe,CAAe,WAAW,EAAE,SAAS,EAAE;IAC1F,SAAS;IACT,UAAU;IACV,UAAU;IACV,QAAQ;IACR,WAAW;IACX,SAAS;IACT,MAAM;CACP,CAAC,CAAC"}
1
+ {"version":3,"file":"components.js","sourceRoot":"","sources":["../src/components.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAO5D,MAAM,CAAC,MAAM,QAAQ,GAAiB,eAAe,CAAe,WAAW,EAAE,SAAS,EAAE;IAC1F,SAAS;IACT,UAAU;IACV,UAAU;IACV,QAAQ;IACR,WAAW;IACX,SAAS;IACT,MAAM;CACP,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,OAAO,GAAiB,eAAe,CAAc,UAAU,EAAE,SAAS,EAAE;IACvF,UAAU;IACV,OAAO;IACP,OAAO;IACP,OAAO;IACP,UAAU;IACV,UAAU;IACV,QAAQ;CACT,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,MAAM,GAAiB,eAAe,CAAa,SAAS,EAAE,SAAS,EAAE;IACpF,OAAO;IACP,QAAQ;IACR,OAAO;CACR,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,OAAO,GAAiB,eAAe,CAAc,UAAU,EAAE,SAAS,EAAE;IACvF,UAAU;IACV,OAAO;IACP,WAAW;IACX,UAAU;IACV,MAAM;IACN,OAAO;IACP,QAAQ;CACT,EACD,OAAO,EAAE,OAAO,CAAC,CAAC;AAGlB,MAAM,CAAC,MAAM,YAAY,GAAiB,eAAe,CAAmB,gBAAgB,EAAE,SAAS,EAAE;IACvG,UAAU;IACV,OAAO;IACP,OAAO;IACP,OAAO;IACP,WAAW;IACX,UAAU;IACV,MAAM;IACN,OAAO;CACR,EACD,OAAO,EAAE,OAAO,CAAC,CAAC;AAGlB,MAAM,CAAC,MAAM,OAAO,GAAiB,eAAe,CAAc,UAAU,EAAE,SAAS,EAAE;IACvF,UAAU;IACV,KAAK;IACL,WAAW;IACX,UAAU;CACX,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wwtdev/bsds-components-vue3",
3
- "version": "0.0.3",
3
+ "version": "0.1.1",
4
4
  "description": "BSDS Vue3 Components",
5
5
  "homepage": "",
6
6
  "license": "ISC",
@@ -22,12 +22,24 @@
22
22
  },
23
23
  "scripts": {
24
24
  "build": "npm run tsc",
25
+ "publish-wwt": "publish-wwt-package --monorepo",
26
+ "publish-npm": "npm publish --@wwtdev:registry=https://registry.npmjs.org --access=public",
27
+ "start": "npm-watch",
25
28
  "test": "echo \"Error: run tests from root\" && exit 1",
26
29
  "tsc": "tsc -p .",
27
- "publish-wwt": "publish-wwt-package --monorepo",
28
- "publish-npm": "npm publish --@wwtdev:registry=https://registry.npmjs.org --access=public"
30
+ "watch": "npm-watch"
31
+ },
32
+ "watch": {
33
+ "build": {
34
+ "patterns": [
35
+ "src"
36
+ ],
37
+ "extensions": "ts",
38
+ "runOnChangeOnly": false
39
+ }
29
40
  },
30
41
  "devDependencies": {
42
+ "npm-watch": "^0.11.0",
31
43
  "vue": "^3.2.39",
32
44
  "wwt-package-publisher": "^4.1.2"
33
45
  },