# README

## Compatibility

| 🌏 Web | 🖥 Electron | 📱 React Native |
| :----: | :---------: | :-------------: |
|   ✔️   |      ✖      |        ✖        |

## Screenshots

|                   🌏 Web                  | 🖥 Electron | 📱 React Native |
| :---------------------------------------: | :---------: | :-------------: |
| ![web image](/files/-LSK1VcBUWwPKkBz-obO) |     TBD     |       TBD       |

## Universal Props

| Name      | Type      | Default | Description                               |
| --------- | --------- | ------- | ----------------------------------------- |
| style     | Object    |         | style object for FormControl component.   |
| children  | ReactNode |         | Children prop for FormControl component.  |
| Component | ReactNode |         | component prop for FormControl component. |
| className | string    |         | ClassName for FormControl component.      |

## Specific Library Props

| Name      | Type    | Default                  | Description                         |
| --------- | ------- | ------------------------ | ----------------------------------- |
| disabled  | boolean |                          | disabled prop for the FormControl.  |
| error     | boolean |                          | error prop for the FormControl.     |
| fullWidth | boolean |                          | fullWidth prop for the FormControl. |
| margin    | string  | 'none' ,'dense','normal' | margin prop for the FormControl.    |
| required  | boolean |                          | required prop for the FormControl.  |
| component | string  |                          | component prop for the FormControl. |

## FormGroup

## FormGroup Universal Props

| Name      | Type      | Default | Description                             |
| --------- | --------- | ------- | --------------------------------------- |
| style     | Object    |         | style object for FormGroup component.   |
| children  | ReactNode |         | Children prop for FormGroup component.  |
| Component | ReactNode |         | component prop for FormGroup component. |
| className | string    |         | ClassName for FormGroup component.      |

## How to use

```javascript
import React from 'react';
import BR  from "@blueeast/bluerain-os";

const FormSample =(props)=> {
   const FormControl = BR.Components.get('FormControl');
   const FormGroup = BR.Components.get('FormGroup');
   const TextInput = BR.Components.get('TextInput');
   const Text = BR.Components.get('Text');
   return (
    <FormControl>
        <FormGroup>
         <TextInput label="Input with success"/>
         <Text>Example help text that remains unchanged.</Text>
        </FormGroup>
        <FormGroup>
         <TextInput label="Input with danger" error={true} errorText={'Example help text that remains unchanged.'}/>
        </FormGroup>
    </FormControl>
  );

};

export default withBluerain(myList);
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://blueeast.gitbook.io/bluerain-plugin-material-ui/src/components/formcontrol.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.