@react-md/avatar
Advanced tools
Changelog
4.0.0 (2021-11-24)
This release focused on updating the @react-md/transition package to no longer log errors in React.StrictMode because react-ransition-group was using ReactDOM.findDOMNode to handle transitions.
All react-md packages will no longer use react-transition-group since all that functionality has been built into @react-md/transition with a slightly different API.
This release has also included my first attempt at automating upgrading to new major releases by introducing a new @react-md/codemod package that is similar to the react-codemod package. You can automate some of this release by running:
npx @react-md/codemod v3-to-v4/preset
Since I am still learning how to use jscodeshift, it will not be able to migrate everything but should still help with most changes.
DropdownMenu and Menu portal by default (98a6a9f), closes #1264eslint (8111cd3)ConditionalPortal supports ReactNode children (c83d578)Typography (30cf056)sass resolutions in package.json (db22cde), closes #1261react-marked-renderer for markdown stuffs (93ebaa4)prettier (9632d82)react-router-dom v6 (e012ef9)sass files (98ffe40)sassdoc to not through uncaught exceptions (8bdf532)prettier after upgrading to v2.4.0 (06110af)enable strict mode by default for nextjs-typescript (83e4c44)create-react-app example to use react-router-dom v6 (3c4d1ea)react-router-dom v6 (ae469ef)stylelint (22d1598)DropdownMenu and Menu components portal by
default. This should really only affect snapshot testslib.d.tsprop-types package.Readme
Create avatars to represent people or objects with images, icons, or text. Different theme colors can also be applied for icons or text.
npm install --save @react-md/avatar
It is generally recommended to also install the following packages since they work hand-in-hand with this package:
npm install --save @react-md/theme \
@react-md/typography \
@react-md/list \
@react-md/icon
You should check out the full documentation for live examples and more customization information, but an example usage is shown below.
One of the main use-cases will probably be to display a list of people with specific avatars with them:
import { render } from "react-dom";
import { Avatar } from "@react-md/avatar";
import { List, ListItem } from "@react-md/list";
const people = [
{ name: "Logan Tyler", avatarUrl: "https://some-picture.com" },
{ name: "Trenton Berry", avatarUrl: "https://some-picture.com" },
{ name: "Damon Fletcher", avatarUrl: "https://some-picture.com" },
{ name: "Thomas Owen", avatarUrl: "https://some-picture.com" },
{ name: "Charity Henderson", avatarUrl: "https://some-picture.com" },
];
const App = () => (
<List>
{people.map(({ name, avatarUrl }, i) => (
<ListItem
id={`person-${i}`}
key={i}
leftAddon={<Avatar src={avatarUrl} alt={`${name}'s avatar'`} />}
leftAddonType="avatar"
>
{name}
</ListItem>
))}
</List>
);
render(<App />, document.getElementById("root"));
FAQs
This package is used to avatars which are used to symbolize people or objects.
We found that @react-md/avatar demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.