Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Optional Semantic UI Theme properties
  • Semantic Widget Optional Properties
  • Custom Semantic Widget Properties
• Roadmap
• Contributing
• Contact

About The Project

Exports semantic-ui theme, fields and widgets for react-jsonschema-form.

Built With

• react-jsonschema-form
• Semantic UI

Getting Started

• See the getting started guide on react-semantic-ui.

Prerequisites

• @semantic-ui-react >= 2
• @semantic-ui-css >= 2 (default theme for semantic-ui); see theming guide if you wish to customize
• @snups/rjsf-core >= 6
• @snups/rjsf-utils >= 6
• @snups/rjsf-validator-ajv8 >= 6

yarn add semantic-ui-css semantic-ui-react @snups/rjsf-core

Installation

yarn add @snups/rjsf-semantic-ui

Usage

import Form from '@snups/rjsf-semantic-ui';

or

import { withTheme } from '@snups/rjsf-core';
import { Theme as SemanticUITheme } from '@snups/rjsf-semantic-ui';

// Make modifications to the theme with your own fields and widgets

const Form = withTheme(SemanticUITheme);

Optional Semantic UI Theme properties

• To pass additional properties to widgets, see this guide.

Semantic Widget Optional Properties

• Semantic props for TextWidget
• Semantic props for CheckboxWidget
• Semantic props for SelectWidget
• Semantic props for RangeWidget
• Semantic props for RadioWidget
• Semantic props for PasswordWidget
• Semantic props for UpDownWidget
• Semantic props for TextAreaWidget

Custom Semantic Widget Properties

Below are the current default options for all widgets:

{
  "ui:options": {
    "semantic": {
      "fluid": true,
      "inverted": false,
      "errorOptions": {
        "size": "small",
        "pointing": "above"
      }
    }
  }
}

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Read our contributors' guide to get started.

Contact

rjsf team: https://github.com/orgs/rjsf-team/people

GitHub repository: https://github.com/rjsf-team/react-jsonschema-form