Back to React Jsonschema Form

README

packages/semantic-ui/README.md

6.5.25.8 KB
Original Source

<!-- PROJECT LOGO --> <p align="center"> <a href="https://github.com/rjsf-team/react-jsonschema-form"> </a> <h3 align="center">rjsf-semantic-ui</h3> <p align="center"> Semantic UI theme, fields and widgets for <a href="https://github.com/rjsf-team/react-jsonschema-form/"><code>react-jsonschema-form</code></a>.
<a href="https://rjsf-team.github.io/react-jsonschema-form/docs/"><strong>Explore the docs »</strong></a>




<a href="https://rjsf-team.github.io/react-jsonschema-form/">View Playground</a>
·
<a href="https://github.com/rjsf-team/react-jsonschema-form/issues">Report Bug</a>
·
<a href="https://github.com/rjsf-team/react-jsonschema-form/issues">Request Feature</a>
</p> </p> <!-- TABLE OF CONTENTS -->

Table of Contents

<!-- ABOUT THE PROJECT -->

About The Project

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

Built With

<!-- GETTING STARTED -->

Getting Started

Prerequisites

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

Installation

sh
yarn add @rjsf/semantic-ui
<!-- USAGE EXAMPLES -->

Usage

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

or

javascript
import { withTheme } from '@rjsf/core';
import { Theme as SemanticUITheme } from '@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

Custom Semantic Widget Properties

Below are the current default options for all widgets:

json
{
  "ui:options": {
    "semantic": {
      "fluid": true,
      "inverted": false,
      "errorOptions": {
        "size": "small",
        "pointing": "above"
      }
    }
  }
}
<!-- ROADMAP -->

Roadmap

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

<!-- CONTRIBUTING -->

Contributing

Read our contributors' guide to get started.

<!-- CONTACT -->

Contact

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

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

<!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->