JSPM

  • Created
  • Published
  • Downloads 201
  • Score
    100M100P100Q88893F
  • License MIT

The Avatar component is a versatile tool to showcase user individuality, offering profile images, initials, and icons. A Person icon is used when no input is available. It supports sizes, accents, live status badges, and stackable AvatarGroups. Customizable through themes, it's ideal for social networks, chat apps, and personalized UI interactions.

Package Exports

  • @tidy-ui/avatar

Readme

Tidy UI

@tidy-ui/avatar npm (scoped)

Quality Gate Status

Publishing Coverage Vulnerabilities Bugs Security Rating Maintainability Rating Code Smells Lines of Code Technical Debt Reliability Rating Duplicated Lines (%)

Project Description

Tidy UI is a family of components necessary for your react application. The components are powered styled-components, features include css-in-js, theming etc

Build with

  • react
  • styled-components
  • rollup
  • lerna

Installation

yarn add @tidy-ui/avatar
npm i @tidy-ui/avatar

Getting started

Here is a sample root level component that should enclose all tidy-ui components

import React from 'react';
import { TidyUiProvider, orchidLight } from '@tidy-ui/commons';
import { ... } from '@tidy-ui/avatar';

function App() {
  return <TidyUiProvider theme={orchidLight}>...</TidyUiProvider>;
}

export default App;

Include required components with in the place holder ...

Storybook

Visit the storybook and start using components in your app.