https://github.com/eclipsesource/jsonforms-vuetify-renderers
https://github.com/eclipsesource/jsonforms-vuetify-renderers
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/eclipsesource/jsonforms-vuetify-renderers
- Owner: eclipsesource
- License: other
- Created: 2021-08-09T08:08:40.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T08:45:10.000Z (over 2 years ago)
- Last Synced: 2024-04-24T19:10:29.418Z (over 2 years ago)
- Language: Vue
- Homepage: https://jsonforms-vuetify-renderers.netlify.app/
- Size: 2.25 MB
- Stars: 23
- Watchers: 6
- Forks: 23
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSON Forms Vuetify renderers
This is a monorepo containing the JSON Forms Vue 2 Vuetify renderers and an example application.
See [jsonforms-vuetify-renderers.netlify.app](https://jsonforms-vuetify-renderers.netlify.app) for the deployed example application.
## JSON Forms
See [jsonforms.io](https://jsonforms.io/) and the [main repository](https://github.com/eclipsesource/jsonforms) for more information about JSON Forms.
## Vue2 Vuetify renderer set
See the [README](https://github.com/eclipsesource/jsonforms-vuetify-renderers/blob/main/vue2-vuetify/README.md) of the Vue 2 Vuetify renderer set for detailed instructions on how to consume and use the JSON Forms Vue 2 Vuetify renderer set.
## Developer documentation
Use Node 12+
### Initial setup
- Install monorepo dependencies: `npm ci`
- Hook up dependencies between packages: `npm run init`
### Scripts
- Build the renderer set: `npm run build`
- Build and watch the renderer set: `npm run watch`
- Remove build artifacts: `npm run clean`
- Run example app: `npm run example:serve`
- Build example app for production: `npm run example:build`
Recommendations:
- For development use `npm run watch` combined with `npm run example:serve`.
- To test production use `npm run build` combined with `npm run example:build`.
Then serve the built application from `example/dist` with a web server of your choice, e.g. `npx http-server example/dist`.
### Use with Vite
When building for production with Vite, custom renderers will not work correctly if their entries are defined within the Single File Component - ie within the custom renderer itself.
To use custom renderers with Vite in production mode, define the entry for any custom renderer outside of the SFC that defines the renderer itself. For example, within the file that imports and registers the renderer. Example repo: https://github.com/yaffol/json-forms-vuetify-vite-seed
See also https://github.com/eclipsesource/jsonforms/issues/2077 and https://jsonforms.discourse.group/t/custom-renderers-not-rendering/1250