https://github.com/x0k/svelte-jsonschema-form

Svelte 5 library for creating forms based on JSON schema.
https://github.com/x0k/svelte-jsonschema-form

forms json-schema svelte svelte5

Last synced: about 2 months ago
JSON representation

Svelte 5 library for creating forms based on JSON schema.

• Host: GitHub
• URL: https://github.com/x0k/svelte-jsonschema-form
• Owner: x0k
• License: mit
• Created: 2024-09-14T22:38:00.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-04T09:55:57.000Z (about 2 months ago)
• Last Synced: 2024-11-04T10:17:53.635Z (about 2 months ago)
• Topics: forms, json-schema, svelte, svelte5
• Language: TypeScript
• Homepage: http://x0k.online/svelte-jsonschema-form/
• Size: 1.36 MB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# svelte-jsonschema-form

Svelte 5 library for creating forms based on JSON schema.

Unofficial port of [react-jsonschema-form](https://github.com/rjsf-team/react-jsonschema-form).

- [Documentation](https://x0k.github.io/svelte-jsonschema-form/)

- [Playground](https://x0k.github.io/svelte-jsonschema-form/playground/)

## Installation

Install the library and `ajv` for validation.

```shell

npm install @sjsf/form @sjsf/ajv8-validator ajv@8

```

## Usage

```svelte

  import { useForm, SimpleForm, type Schema } from '@sjsf/form';

  import { translation } from '@sjsf/form/translations/en';

  import { theme } from '@sjsf/form/basic-theme';

  import { createValidator } from "@sjsf/ajv8-validator";

  const validator = createValidator();

  const schema: Schema = {

    type: 'object',

    properties: {

      name: {

        type: 'string',

        title: 'Name',

      },

      description: {

        type: 'string',

        title: 'Description',

      },

    },

    required: ["name"]

  }

  const form = useForm({

    ...theme,

    schema,

    validator,

    translation,

    onSubmit: console.log,

  })

```

## License

This project includes modifications of code from [react-jsonschema-form](https://github.com/rjsf-team/react-jsonschema-form), which is licensed under the Apache License, Version 2.0.

The rest of the project is under the MIT license.

See [LICENSE-MIT](packages/form/LICENSE-MIT) and [LICENSE-APACHE](packages/form/LICENSE-APACHE) for details.

## See also

- [Other JSON Schema to Web UI tools](https://json-schema.org/tools?query=&sortBy=name&sortOrder=ascending&groupBy=toolingTypes&licenses=&languages=&drafts=&toolingTypes=schema-to-web-UI)

- [Converting JSON to table](https://github.com/x0k/json-to-table)

- Simple build automation tool [mk](https://github.com/x0k/mk)