@sjsf/form - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

LICENSE

+Copyright (c) 2024 Roman Krasilnikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

+# @sjsf/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
+<script lang="ts">
+  import Ajv from 'ajv';
+  import { Form } from '@sjsf/form';
+  import { translation } from '@sjsf/form/translations/en';
+  import { theme } from '@sjsf/form/basic-theme';
+  import {
+    AjvValidator,
+    addFormComponents,
+    DEFAULT_AJV_CONFIG,
+  } from "@sjsf/ajv8-validator";
+
+  const validator = new AjvValidator(
+    addFormComponents(new Ajv(DEFAULT_AJV_CONFIG))
+  );
+</script>
+
+<Form
+  {...theme}
+  schema={{
+    title: 'Tasks',
+    type: 'array',
+    items: {
+      type: 'object',
+      properties: {
+        name: {
+          type: 'string',
+          title: 'Name',
+        },
+        description: {
+          type: 'string',
+          title: 'Description',
+        },
+      },
+      required: ["name"]
+    },
+  }}
+  {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](LICENSE-MIT) and [LICENSE-APACHE](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)

package.json

 {
   "name": "@sjsf/form",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Svelte 5 library for creating forms based on JSON schema.",
@@ -16,4 +16,3 @@ "license": "(MIT AND Apache-2.0)",
   "publishConfig": {
-    "provenance": true,
-    "access": "public"
+    "provenance": true
   },
@@ -20,0 +19,0 @@ "repository": {

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

469522

0.64%

Number of package files

251

0.8%

Number of medium quality alerts

1

-50%

Number of lines in readme file

74

Infinity%

No dependency changes