# CRUDComponent

CRUD component

## Installation

```tsx
import { CRUDComponent } from 'uxp/components';
```

## Signature

```tsx
const CRUDComponent: React.ForwardRefExoticComponent<React.RefAttributes<CRUDComponentInstanceProps> & CRUDComponentProps>
```

## Properties

| Name                 | Type                                                                                                  | Mandatory | Default Value | Example Value |
| -------------------- | ----------------------------------------------------------------------------------------------------- | --------- | ------------- | ------------- |
| list                 | [ListProps](https://help.iviva.com/uxp/v5/additional-resources/types/listprops)                       | Yes       | -             | -             |
| add                  | [FormProps](https://help.iviva.com/uxp/v5/additional-resources/types/formprops)                       | No        | -             | -             |
| renderCustomAddView  | [RenderCustomFormView](https://help.iviva.com/uxp/v5/additional-resources/types/rendercustomformview) | No        | -             | -             |
| edit                 | [ExtendedFormProps](https://help.iviva.com/uxp/v5/additional-resources/types/extendedformprops)       | No        | -             | -             |
| renderCustomEditView | [RenderCustomFormView](https://help.iviva.com/uxp/v5/additional-resources/types/rendercustomformview) | No        | -             | -             |
| disableViews         | { add?: boolean; edit?: boolean; delete?: boolean; }                                                  | No        | -             | -             |
| entityName           | string                                                                                                | No        | -             | -             |
| className            | string                                                                                                | No        | -             | -             |

## Ref Handlers

Available methods through ref:

| Method      | Type       | Description                |
| ----------- | ---------- | -------------------------- |
| refreshList | () => void | option to refresh the list |

## Related Types

* [CRUDComponentProps](https://help.iviva.com/uxp/v5/additional-resources/types/crudcomponentprops)
* [ListProps](https://help.iviva.com/uxp/v5/additional-resources/types/listprops)
* [TableColumn](https://help.iviva.com/uxp/v5/additional-resources/types/tablecolumn)
* [Column](https://help.iviva.com/uxp/v5/additional-resources/types/column)
* [ActionResponse](https://help.iviva.com/uxp/v5/additional-resources/types/actionresponse)
* [FormProps](https://help.iviva.com/uxp/v5/additional-resources/types/formprops)
* [DynamicFormProps](https://help.iviva.com/uxp/v5/additional-resources/types/dynamicformprops)
* [FormSectionProps](https://help.iviva.com/uxp/v5/additional-resources/types/formsectionprops)
* [DynamicFormFieldProps](https://help.iviva.com/uxp/v5/additional-resources/types/dynamicformfieldprops)
* [FormValue](https://help.iviva.com/uxp/v5/additional-resources/types/formvalue)
* [IFormData](https://help.iviva.com/uxp/v5/additional-resources/types/iformdata)
* [CustomValidateResponse](https://help.iviva.com/uxp/v5/additional-resources/types/customvalidateresponse)
* [RenderCustomFormView](https://help.iviva.com/uxp/v5/additional-resources/types/rendercustomformview)
* [ExtendedFormProps](https://help.iviva.com/uxp/v5/additional-resources/types/extendedformprops)
* [CRUDComponentInstanceProps](https://help.iviva.com/uxp/v5/additional-resources/types/crudcomponentinstanceprops)