From 108f549cd4595fdf9404648e470e7df5e9476b0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Po=C5=9Bpiech?= <37746259+piotrpospiech@users.noreply.github.com> Date: Wed, 30 Oct 2024 10:16:13 +0100 Subject: [PATCH] updated what-are-uniforms page --- .../docs/introduction/what-are-uniforms.md | 30 ------------------- .../docs/introduction/what-are-uniforms.mdx | 26 ++++++++++++++++ 2 files changed, 26 insertions(+), 30 deletions(-) delete mode 100644 apps/docs/src/content/docs/introduction/what-are-uniforms.md create mode 100644 apps/docs/src/content/docs/introduction/what-are-uniforms.mdx diff --git a/apps/docs/src/content/docs/introduction/what-are-uniforms.md b/apps/docs/src/content/docs/introduction/what-are-uniforms.md deleted file mode 100644 index 4a41e7acf..000000000 --- a/apps/docs/src/content/docs/introduction/what-are-uniforms.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: what-are-uniforms -title: What are uniforms? -sidebar: - order: 1 ---- - -Generally speaking, uniforms are a set of React libraries for building forms from every schema. - -### Core features - -- Automatic forms generation -- Fields capable of rendering every schema -- Helper for creating custom fields with one line -- Inline and asynchronous form validation -- Various schemas integration -- Wide range of themes support - -Similarly to other form packages, uniforms can help you with rendering a form, by taking care of its state management, validation, and submission. -What makes it unique though, is the ability to **completely generate the form** for you, without having to manually provide its fields. - -In order to do so, uniforms require you to do two things: - -1. Provide **the schema** of your data. You can approach the schema as a formal description of the data, where you define its types, allowed values, default values, required ones and so on. -2. Select desired **theme**. The theme is basically a package containing pre-styled form components in one of the popular styles (AntD, Bootstrap 3, Bootstrap 4, Bootstrap 5, Material, MUI, Semantic) or raw, unstyled HTML. - -To operate on the schema, uniforms will need to receive a _bridge_ of it. -A bridge is a unified schema mapper that is used by uniforms internals in order to be able to operate on the schema data, validate it and generate errors. -To create one, you have to use one of the predefined schema-to-bridge mappers or create one by yourself. -To learn more about the bridge concept, please visit the [Under The Hood > Bridge concept](/docs/uth-bridge-concept) section. diff --git a/apps/docs/src/content/docs/introduction/what-are-uniforms.mdx b/apps/docs/src/content/docs/introduction/what-are-uniforms.mdx new file mode 100644 index 000000000..7ab79e208 --- /dev/null +++ b/apps/docs/src/content/docs/introduction/what-are-uniforms.mdx @@ -0,0 +1,26 @@ +--- +id: what-are-uniforms +title: What are uniforms? +sidebar: + order: 1 +--- + +import { Aside } from '@astrojs/starlight/components'; + +**_Uniforms_** is a set of React libraries designed to simplify form creation by generating complete forms from any data schema. It handles form state management, validation, and submission, allowing you to focus on your app’s functionality rather than manual form-building. + +### Key Features + +- **_Automatic Form Generation:_** Uniforms can generate entire forms based on the provided schema, eliminating the need for manual field creation. +- **_Flexible Field Rendering:_** Renders fields according to any schema structure. +- **_Customizable Fields:_** Provides helpers to create custom fields with minimal code. +- **_Built-in Validation:_** Supports both synchronous and asynchronous validation. +- **_Schema Compatibility:_** Works with multiple schema formats through integration with schema libraries. +- **_Theme Support:_** Offers a wide variety of themes, including popular frameworks like Bootstrap, Material UI, and Semantic UI. + +