awesome-gcl/dist/types/src/components/User/index.d.ts

React component library

import React from "react";
import { UserPropTypes } from "./types";
/**
 * User component
 * @param {UserPropTypes} props
 * @property {string} [props.profileImage] - Url used as src for img HTML tag
 * @property {string} props.firstName - Determines initials value in case no image is provided
 * @property {string} props.lastName - Determines initials value in case no image is provided
 * @property {string} [props.description] - Determines the value for description an if it should be rendered
 * @property {GSizeEnum} props.size
 * @property {UserAdditionalClasses} [props.additionalClasses] - Option css classes
 * @property {string[]} [props.additionalClasses.wrapper] - CSS classes for wrapper div HTML tag
 * @property {string[]} [props.additionalClasses.avatar] - CSS classes for img HTML tag
 * @property {string[]} [props.additionalClasses.initials] - CSS classes for initials div HTML tag
 * @property {string[]} [props.additionalClasses.info] - CSS classe for indo div HTML tag
 * @property {string[]} [props.additionalClasses.name] = CSS classes for name p HTML tag
 * @property {string[]} [props.additionalClasses.description] - CSS classes for description p HTML tag
 * @example
 * <User
 *  size='large'
 *  profileImage:'path/to/image'
 *  firstName: 'John'
 *  lastName: 'Doe'
 *  description: 'johndoe@email.com'
 * />
 *
 * @returns {JSX.Element} User
 */
export declare const User: ({ profileImage, firstName, lastName, description, size, additionalClasses }: UserPropTypes) => React.JSX.Element;