@data-driven-forms/pf4-component-mapper
TypeScript icon, indicating that this package has built-in type declarations

3.22.4 • Public • Published

npm version Tweet Twitter Follow

Data Driven Form logo

Patternfly 4 component mapper for Data Driven Forms.

📖 For more information please visit the documentation. 📖

Table of Contents

More information

For more information please check the root repository or our documentation page.

Installation

You need to add React Form Renderer

$ npm install @data-driven-forms/react-form-renderer -S
$ yarn add @data-driven-forms/react-form-renderer
$ npm install @data-driven-forms/pf4-component-mapper -S
$ yarn add @data-driven-forms/pf4-component-mapper

Usage

For using Data Driven Forms in your component you need the renderer and a component mapper, which provides formFields components and layoutFields components.

import React from 'react';
import { FormRenderer, componentTypes } from '@data-driven-forms/react-form-renderer';
import { componentMapper, FormTemplate } from '@data-driven-forms/pf4-component-mapper';

const schema = {
  fields: [{
    component: componentTypes.TEXT_FIELD,
    name: 'name',
    label: 'Your name'
  }]
}

const Form = () => (
  <FormRenderer
    schema={schema}
    componentMapper={componentMapper}
    FormTemplate={FormTemplate}
    onSubmit={console.log}
  />
)

Basic provided components

Data Driven Forms supports all kinds of component, basic set is consisted of:

ValidateOnMount

PF4 mapper provides an option to validate a field when the component is mounted. Just set validateOnMount to true.

{
    component: 'text-field',
    name: 'required-field',
    validate: [{type: 'required'}],
    validateOnMount: true
}

This field will show the error immediately.

Useful links

Contribution

We welcome any community contribution. Don't be afraid to report bug or to create issues and pull-requests! 🏆

LICENSE

Apache License 2.0

Readme

Keywords

Package Sidebar

Install

npm i @data-driven-forms/pf4-component-mapper

Weekly Downloads

1,223

Version

3.22.4

License

Apache-2.0

Unpacked Size

371 kB

Total Files

204

Last publish

Collaborators

  • hyperkid
  • rvsia