react-avatar - npm Package Compare versions

Comparing version 3.4.1 to 3.4.2

index.d.ts

@@ -30,2 +30,9 @@ import * as React from "react";
     /**
+     * Initials to show or a method converting name into initials
+     * @param {string} name
+     * @param {any} value
+     * @returns {string}
+     */
+    initials?: string | ((name: string, props: any) => string);
+    /**
      * Show a value as avatar
@@ -83,2 +90,13 @@ */
     cache?: Cache;
+    /**
+     * Method converting name into initials
+     * @param {string} name
+     * @param {any} value
+     * @returns {string}
+     */
+    initials?: (name: string, props: any) => string;
+    /**
+     * The baseUrl for a avatar-redirect service
+     */
+    avatarRedirectUrl?: string;
 }
@@ -85,0 +103,0 @@

package.json

 {
   "name": "react-avatar",
-  "version": "3.4.1",
+  "version": "3.4.2",
   "description": "Universal React avatar component makes it possible to generate avatars based on user information.",
   "main": "lib/index.js",
   "module": "es/index.js",
+  "types": "index.d.ts",
   "typings": "index.d.ts",
@@ -38,3 +39,3 @@ "scripts": {
   ],
-  "homepage": "https://github.com/sitebase/react-avatar",
+  "homepage": "https://www.sitebase.be/react-avatar/",
   "peerDependencies": {
@@ -41,0 +42,0 @@ "react": "^15.0.0 || ^16.0.0",

README.md

@@ -1,2 +0,3 @@
-# <Avatar>[![Build Status](https://travis-ci.org/Sitebase/react-avatar.svg?branch=master)](https://travis-ci.org/Sitebase/react-avatar)
+# <Avatar> [![Build Status](https://travis-ci.org/Sitebase/react-avatar.svg?branch=master)](https://travis-ci.org/Sitebase/react-avatar) [![npm downloads](https://img.shields.io/npm/dm/react-avatar.svg)](https://www.npmjs.com/package/react-avatar) [![version](https://img.shields.io/npm/v/react-avatar.svg)](https://www.npmjs.com/package/react-avatar) ![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/react-avatar.svg) ![npm type definitions](https://img.shields.io/npm/types/react-avatar.svg)
+
 Universal avatar makes it possible to fetch/generate an avatar based on the information you have about that user.
@@ -32,8 +33,5 @@ We use a fallback system that if for example an invalid Facebook ID is used it will try Google, and so on.
 
-# besides React, react-avatar also has react-addons-shallow-compare and prop-types
-# as peer dependencies, make sure to install the correct version
-# for your version of react
-$ npm install react-addons-shallow-compare@^0.14 --save
-# OR
-$ npm install react-addons-shallow-compare@^15 --save
+# besides React, react-avatar also has prop-types as peer dependency,
+# make sure to install it into your project
+$ npm install prop-types --save
 ```
@@ -181,3 +179,3 @@
 ## Products using React Avatar
-* [BuboBox](https://www.bubobox.com/?utm_source=github&utm_medium=readme&utm_campaign=react-avatar)
+
 * [Ambassify](https://www.ambassify.com/?utm_source=github&utm_medium=readme&utm_campaign=react-avatar)
@@ -184,0 +182,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

103866

increased by0.66%

Lines of code

1992

increased by0.91%

Number of medium supply chain risk alerts

2

decreased by-33.33%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

204

decreased by-0.97%

No dependency changes