jobiqo-cl
Version:
[](https://circleci.com/gh/jobiqo/jobiqo-cl)
43 lines (42 loc) • 1.21 kB
TypeScript
/**
* @file index.tsx
*
* @fileoverview Creates a group of several form items and displays them
* together under a single label and description.
*/
import React from 'react';
export interface FormGroupProps {
/**
* The form elements to be added in the formGroup.
*/
children: React.ReactNode;
/**
* The label to display in the form group.
*/
label?: string;
/**
* Description for the form Group.
*/
description?: string;
/**
* The icon to use next to the label.
*/
icon?: React.ReactNode;
/**
* The theme props is passed automatically to the component via styled components.
*
* @default "null"
*/
theme?: any;
/**
* If all forms in the field are valid, the icon and info will become success color.
*/
valid?: boolean;
}
/**
* The form group component groups several form items together in a group.
* For longer forms it is recommended to group items together in logical
* groups so that the user can scan the form more easily.
*/
export declare const FormGroup: ({ children, label, description, icon, valid, ...props }: FormGroupProps) => JSX.Element;
export default FormGroup;