@dynamicforms/vuetify-inputs 0.11.7 → 0.13.0

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/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@dynamicforms/vuetify-inputs",
3
3
  "private": false,
4
- "version": "0.11.7",
4
+ "version": "0.13.0",
5
5
  "type": "module",
6
6
  "description": "Vuetify input components with guaranteed visual consistency across all form fields — unified density/variant system, globally configurable, with inline mode for table cells. Built for @dynamicforms/vue-forms.",
7
7
  "author": "Jure Erznožnik",
@@ -25,8 +25,8 @@
25
25
  "build": "vite build",
26
26
  "test": "vitest run --coverage",
27
27
  "test:e2e": "playwright test",
28
- "lint": "eslint src --fix && vue-tsc --noEmit",
29
- "lint:ci": "eslint src && vue-tsc --noEmit",
28
+ "lint": "eslint src docs/components --fix && vue-tsc --noEmit && vue-tsc --noEmit -p docs/tsconfig.json",
29
+ "lint:ci": "eslint src docs/components && vue-tsc --noEmit && vue-tsc --noEmit -p docs/tsconfig.json",
30
30
  "docs:dev": "npm run docs:dev -w docs",
31
31
  "docs:build": "npm run docs:build -w docs",
32
32
  "docs:preview": "npm run docs:preview -w docs"
@@ -56,8 +56,8 @@
56
56
  "url": "https://github.com/dynamicforms/vuetify-inputs/issues"
57
57
  },
58
58
  "peerDependencies": {
59
- "@dynamicforms/translatable": "^0.1.0",
60
- "@dynamicforms/vue-forms": "^1.0.0",
59
+ "@dynamicforms/translatable": "^0.3.0",
60
+ "@dynamicforms/vue-forms": "^3.0.0-alpha.1",
61
61
  "@mdi/font": "^7.4.47",
62
62
  "@tiptap/core": "^3.30.2",
63
63
  "@tiptap/extension-image": "^3.30.2",
@@ -73,9 +73,8 @@
73
73
  "@tiptap/vue-3": "^3.30.2",
74
74
  "date-fns": "^4.1.0",
75
75
  "lodash-es": "^4.17.12",
76
- "vitepress-plugin-crosslinks": "^1.0.0",
77
76
  "vue": "^3.5.2",
78
- "vue-cached-icon": "^3.0.3",
77
+ "vue-cached-icon": "^3.2.0",
79
78
  "vue-markdown-render": "^2.2.1",
80
79
  "vuetify": "^3.9"
81
80
  },
package/readme.md CHANGED
@@ -8,11 +8,9 @@ Vuetify input components with guaranteed visual consistency across all form fiel
8
8
  every other.
9
9
 
10
10
  Hand a component an element of [@dynamicforms/vue-forms](https://github.com/dynamicforms/vue-forms) and that element
11
- owns the value, the validation, the enabled state and the visibility, and the component draws what it holds. That is
12
- what the library was built for, and it is not what it requires: every component works just as well with a plain
13
- `v-model`, or with no binding at all. The visual consistency, the density and variant system and the inline mode for
14
- table cells are the same either way, so the components are worth reaching for whether or not you want a form model
15
- behind them.
11
+ owns the value, the validation, the enabled state and the visibility, and the component renders what it holds. Every
12
+ component also works with a plain `v-model`, or with no binding. The density and variant system and the inline mode
13
+ for table cells are the same in all three cases.
16
14
 
17
15
  ## Design Goals
18
16
 
@@ -55,10 +53,13 @@ consistent appearance.
55
53
  `df-rtf-editor`, `df-actions` and `df-input-hint`
56
54
  - **A control, a v-model, or neither**: a bound element owns the value, validity, touched, enabled and visibility;
57
55
  `v-model` reports changes to the parent; neither keeps the value internally
58
- - **Errors, hints and help text** in one row, rendered through vue-forms' `MessagesWidget`, so an error may be
59
- plain text, markdown or a component of its own
60
- - **Labels with icons and markdown**, through the `Label` class and `MdString`
61
- - **Visibility through `DisplayMode`** — `FULL`, `HIDDEN`, `INVISIBLE`, `SUPPRESS` — and enablement that follows the
56
+ - **Errors, hints and help text** in one row, rendered through the library's own `MessagesWidget`; an error
57
+ renders as the plain text, markdown or component the application's `errorText` setting returns for its code and
58
+ params, or as its English `detail`, and is shown by one rule an application can replace — the server's at once,
59
+ every other once the field is touched
60
+ - **Labels with icons, markdown, HTML or a component**, through the `Label` class, `MdString`, `HtmlString` and
61
+ `SimpleComponentDef`
62
+ - **Visibility** — `'full'`, `'invisible'`, `'hidden'`, `'suppress'` — and enablement that follows the
62
63
  containing section
63
64
  - **`passthroughAttrs`**: any prop of the underlying Vuetify component, without this library declaring it
64
65
  - **Actions**: the `Action` class with render options, `defaultConfirm` / `defaultReject`, the ready-made
@@ -67,11 +68,11 @@ consistent appearance.
67
68
  `allowTags`
68
69
  - **Uploads**: a `FileComms` object with upload progress, delete and a periodic touch
69
70
  - **Rich text**: TipTap with a Vuetify toolbar, inside the same field frame as every other input
70
- - **Localisable**: `translateStrings()` replaces the library's own strings, including every RTF editor toolbar
71
- label and `<df-image>`/`<df-file>`'s upload and download prompts, and `DateTimeLocaleConfig` sets the date-fns
72
- locale dates are formatted and parsed with — see the
73
- [localisation example](https://docs.velis.si/dynamicforms/vuetify-inputs/examples/localisation.html) for every
74
- key and a worked example
71
+ - **Localisable**: `translateStrings()`, or the `translate` setting per app, connects the library's own strings,
72
+ including every RTF editor toolbar label and `<df-image>`/`<df-file>`'s upload and download prompts, to the
73
+ application's translation function; the `errorText` setting translates errors; `DateTimeLocaleConfig`, or the
74
+ `dateTimeLocale` setting per app, sets the date-fns locale dates are formatted and parsed with — see the [localisation example](https://docs.velis.si/dynamicforms/vuetify-inputs/examples/localisation.html)
75
+ for every key and a worked example
75
76
  - **TypeScript**: every component's props are an exported interface, and the definitions ship with the build
76
77
 
77
78
  ## Installation
@@ -162,7 +163,8 @@ Detailed documentation is available at [https://docs.velis.si/dynamicforms/vueti
162
163
  ## Available Components
163
164
 
164
165
  - **InputBase**: The base component for all input elements
165
- - **DfLabel**: Renders a label - plain text, markdown or an icon - the way every input renders its own
166
+ - **DfLabel**: Renders a label - plain text, markdown, HTML or a component, with an icon - the way every input renders
167
+ its own
166
168
  - **df-actions**: An actions group.
167
169
  - **df-checkbox**: A checkbox component.
168
170
  - **df-color**: A color input.