@leafygreen-ui/badge - npm Package Compare versions

Comparing version 1.1.1 to 2.0.0

dist/Badge.d.ts

@@ -1,12 +0,10 @@
-import React, { PureComponent } from 'react';
+import React from 'react';
 import PropTypes from 'prop-types';
 export declare const Variant: {
-    readonly Default: "default";
-    readonly Dark: "dark";
-    readonly Danger: "danger";
-    readonly Warning: "warning";
-    readonly DarkBlue: "darkBlue";
-    readonly LightBlue: "lightBlue";
-    readonly Primary: "primary";
-    readonly Outline: "outline";
+    readonly DarkGray: "darkgray";
+    readonly LightGray: "lightgray";
+    readonly Red: "red";
+    readonly Yellow: "yellow";
+    readonly Blue: "blue";
+    readonly Green: "green";
 };
@@ -16,22 +14,29 @@ export declare type Variant = typeof Variant[keyof typeof Variant];
 export declare const badgeVariants: {
-    readonly [K in Variant]: string;
+    [K in Variant]: string;
 };
 interface BadgeProps {
-    className: string;
+    /**
+     * An additional className to add to the component's classList
+     */
+    className?: string;
+    /**
+     * The content to render within the badge
+     */
     children?: React.ReactNode;
-    variant: Variant;
+    /**
+     * The Badge's style variant
+     *
+     * Default: `'lightgray'`
+     */
+    variant?: Variant;
 }
-export default class Badge extends PureComponent<BadgeProps & React.HTMLAttributes<HTMLDivElement>> {
-    static displayName: string;
-    static propTypes: {
+declare function Badge({ children, variant, className, ...rest }: BadgeProps & React.HTMLAttributes<HTMLDivElement>): JSX.Element;
+declare namespace Badge {
+    var displayName: string;
+    var propTypes: {
         className: PropTypes.Requireable<string>;
         children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        variant: PropTypes.Requireable<"default" | "dark" | "outline" | "danger" | "warning" | "darkBlue" | "lightBlue" | "primary">;
+        variant: PropTypes.Requireable<"blue" | "darkgray" | "green" | "lightgray" | "red" | "yellow">;
     };
-    static defaultProps: {
-        className: string;
-        variant: "default";
-    };
-    render(): JSX.Element;
 }
-export {};
+export default Badge;

dist/index.js

@@ -1,2 +0,2 @@
-!function(e,r){if("object"==typeof exports&&"object"==typeof module)module.exports=r(require("react"),require("prop-types"),require("@leafygreen-ui/theme"),require("@leafygreen-ui/emotion"));else if("function"==typeof define&&define.amd)define(["react","prop-types","@leafygreen-ui/theme","@leafygreen-ui/emotion"],r);else{var t="object"==typeof exports?r(require("react"),require("prop-types"),require("@leafygreen-ui/theme"),require("@leafygreen-ui/emotion")):r(e.react,e["prop-types"],e["@leafygreen-ui/theme"],e["@leafygreen-ui/emotion"]);for(var o in t)("object"==typeof exports?exports:e)[o]=t[o]}}(window,function(e,r,t,o){return function(e){var r={};function t(o){if(r[o])return r[o].exports;var n=r[o]={i:o,l:!1,exports:{}};return e[o].call(n.exports,n,n.exports,t),n.l=!0,n.exports}return t.m=e,t.c=r,t.d=function(e,r,o){t.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:o})},t.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.t=function(e,r){if(1&r&&(e=t(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var o=Object.create(null);if(t.r(o),Object.defineProperty(o,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var n in e)t.d(o,n,function(r){return e[r]}.bind(null,n));return o},t.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(r,"a",r),r},t.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},t.p="",t(t.s=0)}([function(e,r,t){"use strict";Object.defineProperty(r,"__esModule",{value:!0}),Object.defineProperty(r,"Variant",{enumerable:!0,get:function(){return o.Variant}}),r.default=void 0;var o=function(e){if(e&&e.__esModule)return e;var r={};if(null!=e)for(var t in e)if(Object.prototype.hasOwnProperty.call(e,t)){var o=Object.defineProperty&&Object.getOwnPropertyDescriptor?Object.getOwnPropertyDescriptor(e,t):{};o.get||o.set?Object.defineProperty(r,t,o):r[t]=e[t]}return r.default=e,r}(t(1));var n=o.default;r.default=n},function(e,r,t){"use strict";Object.defineProperty(r,"__esModule",{value:!0}),r.default=r.badgeVariants=r.baseStyle=r.Variant=void 0;var o,n=function(e){if(e&&e.__esModule)return e;var r={};if(null!=e)for(var t in e)if(Object.prototype.hasOwnProperty.call(e,t)){var o=Object.defineProperty&&Object.getOwnPropertyDescriptor?Object.getOwnPropertyDescriptor(e,t):{};o.get||o.set?Object.defineProperty(r,t,o):r[t]=e[t]}return r.default=e,r}(t(2)),i=(o=t(3))&&o.__esModule?o:{default:o},a=t(4),u=t(5);function l(e){return(l="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e})(e)}function c(){return(c=Object.assign||function(e){for(var r=1;r<arguments.length;r++){var t=arguments[r];for(var o in t)Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o])}return e}).apply(this,arguments)}function f(e,r){if(null==e)return{};var t,o,n=function(e,r){if(null==e)return{};var t,o,n={},i=Object.keys(e);for(o=0;o<i.length;o++)t=i[o],r.indexOf(t)>=0||(n[t]=e[t]);return n}(e,r);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o<i.length;o++)t=i[o],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}function s(e,r){for(var t=0;t<r.length;t++){var o=r[t];o.enumerable=o.enumerable||!1,o.configurable=!0,"value"in o&&(o.writable=!0),Object.defineProperty(e,o.key,o)}}function p(e,r){return!r||"object"!==l(r)&&"function"!=typeof r?function(e){if(void 0===e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return e}(e):r}function d(e){return(d=Object.setPrototypeOf?Object.getPrototypeOf:function(e){return e.__proto__||Object.getPrototypeOf(e)})(e)}function y(e,r){return(y=Object.setPrototypeOf||function(e,r){return e.__proto__=r,e})(e,r)}function b(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}var g={Default:"default",Dark:"dark",Danger:"danger",Warning:"warning",DarkBlue:"darkBlue",LightBlue:"lightBlue",Primary:"primary",Outline:"outline"};r.Variant=g;var m=(0,u.css)("display:inline-flex;align-items:center;font-weight:bold;font-size:11px;line-height:20px;border-radius:50px;height:20px;padding-left:9px;padding-right:9px;text-transform:uppercase;color:",a.colors.mongodb.white,";");r.baseStyle=m;var O={default:(0,u.css)("background-color:",a.colors.gray[6],";color:",a.colors.gray[3],";"),dark:(0,u.css)("background-color:",a.colors.gray[2],";"),danger:(0,u.css)("background-color:",a.colors.mongodb.red,";"),warning:(0,u.css)("background-color:",a.colors.mongodb.yellow,";"),darkBlue:(0,u.css)("background-color:",a.colors.mongodb.navyBlue,";"),lightBlue:(0,u.css)("background-color:",a.colors.mongodb.blue,";"),primary:(0,u.css)("background-color:",a.colors.mongodb.green,";"),outline:(0,u.css)("border:1px solid ",a.colors.gray[3],";color:",a.colors.gray[3],";")};r.badgeVariants=O;var v=function(e){function r(){return function(e,r){if(!(e instanceof r))throw new TypeError("Cannot call a class as a function")}(this,r),p(this,d(r).apply(this,arguments))}var t,o,i;return function(e,r){if("function"!=typeof r&&null!==r)throw new TypeError("Super expression must either be null or a function");e.prototype=Object.create(r&&r.prototype,{constructor:{value:e,writable:!0,configurable:!0}}),r&&y(e,r)}(r,n.PureComponent),t=r,(o=[{key:"render",value:function(){var e=this.props,r=e.children,t=e.variant,o=e.className,i=f(e,["children","variant","className"]);return n.default.createElement("div",c({},i,{className:(0,u.cx)(m,O[t],o)}),r)}}])&&s(t.prototype,o),i&&s(t,i),r}();r.default=v,b(v,"displayName","Badge"),b(v,"propTypes",{className:i.default.string,children:i.default.node,variant:i.default.oneOf(Object.values(g))}),b(v,"defaultProps",{className:"",variant:g.Default})},function(r,t){r.exports=e},function(e,t){e.exports=r},function(e,r){e.exports=t},function(e,r){e.exports=o}])});
+!function(e,r){if("object"==typeof exports&&"object"==typeof module)module.exports=r(require("react"),require("prop-types"),require("@leafygreen-ui/palette"),require("@leafygreen-ui/emotion"));else if("function"==typeof define&&define.amd)define(["react","prop-types","@leafygreen-ui/palette","@leafygreen-ui/emotion"],r);else{var t="object"==typeof exports?r(require("react"),require("prop-types"),require("@leafygreen-ui/palette"),require("@leafygreen-ui/emotion")):r(e.react,e["prop-types"],e["@leafygreen-ui/palette"],e["@leafygreen-ui/emotion"]);for(var o in t)("object"==typeof exports?exports:e)[o]=t[o]}}(window,function(e,r,t,o){return function(e){var r={};function t(o){if(r[o])return r[o].exports;var n=r[o]={i:o,l:!1,exports:{}};return e[o].call(n.exports,n,n.exports,t),n.l=!0,n.exports}return t.m=e,t.c=r,t.d=function(e,r,o){t.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:o})},t.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.t=function(e,r){if(1&r&&(e=t(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var o=Object.create(null);if(t.r(o),Object.defineProperty(o,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var n in e)t.d(o,n,function(r){return e[r]}.bind(null,n));return o},t.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(r,"a",r),r},t.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},t.p="",t(t.s=0)}([function(e,r,t){"use strict";Object.defineProperty(r,"__esModule",{value:!0}),Object.defineProperty(r,"Variant",{enumerable:!0,get:function(){return o.Variant}}),r.default=void 0;var o=function(e){if(e&&e.__esModule)return e;var r={};if(null!=e)for(var t in e)if(Object.prototype.hasOwnProperty.call(e,t)){var o=Object.defineProperty&&Object.getOwnPropertyDescriptor?Object.getOwnPropertyDescriptor(e,t):{};o.get||o.set?Object.defineProperty(r,t,o):r[t]=e[t]}return r.default=e,r}(t(1));var n=o.default;r.default=n},function(e,r,t){"use strict";Object.defineProperty(r,"__esModule",{value:!0}),r.default=r.badgeVariants=r.baseStyle=r.Variant=void 0;var o,n=u(t(2)),l=u(t(3)),i=t(4),a=t(5);function u(e){return e&&e.__esModule?e:{default:e}}function c(){return(c=Object.assign||function(e){for(var r=1;r<arguments.length;r++){var t=arguments[r];for(var o in t)Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o])}return e}).apply(this,arguments)}function s(e,r){if(null==e)return{};var t,o,n=function(e,r){if(null==e)return{};var t,o,n={},l=Object.keys(e);for(o=0;o<l.length;o++)t=l[o],r.indexOf(t)>=0||(n[t]=e[t]);return n}(e,r);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(o=0;o<l.length;o++)t=l[o],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}function f(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}var d={DarkGray:"darkgray",LightGray:"lightgray",Red:"red",Yellow:"yellow",Blue:"blue",Green:"green"};r.Variant=d;var p=(0,a.css)("display:inline-flex;align-items:center;font-weight:bold;font-size:11px;line-height:20px;border-radius:50px;height:20px;padding-left:9px;padding-right:9px;text-transform:uppercase;border:1px solid;");r.baseStyle=p;var y=(f(o={},d.LightGray,(0,a.css)("background-color:",i.uiColors.gray.light3,";border-color:",i.uiColors.gray.light2,";color:",i.uiColors.gray.dark1,";")),f(o,d.DarkGray,(0,a.css)("background-color:",i.uiColors.gray.dark2,";border-color:",i.uiColors.gray.dark3,";color:",i.uiColors.white,";")),f(o,d.Red,(0,a.css)("background-color:",i.uiColors.red.light3,";border-color:",i.uiColors.red.light2,";color:",i.uiColors.red.dark2,";")),f(o,d.Yellow,(0,a.css)("background-color:",i.uiColors.yellow.light3,";border-color:",i.uiColors.yellow.light2,";color:",i.uiColors.yellow.dark2,";")),f(o,d.Blue,(0,a.css)("background-color:",i.uiColors.blue.light3,";border-color:",i.uiColors.blue.light2,";color:",i.uiColors.blue.dark2,";")),f(o,d.Green,(0,a.css)("background-color:",i.uiColors.green.light3,";border-color:",i.uiColors.green.light2,";color:",i.uiColors.green.dark2,";")),o);function g(e){var r=e.children,t=e.variant,o=void 0===t?d.LightGray:t,l=e.className,i=s(e,["children","variant","className"]);return n.default.createElement("div",c({},i,{className:(0,a.cx)(p,y[o],l)}),r)}r.badgeVariants=y,g.displayName="Badge",g.propTypes={className:l.default.string,children:l.default.node,variant:l.default.oneOf(Object.values(d))};var b=g;r.default=b},function(r,t){r.exports=e},function(e,t){e.exports=r},function(e,r){e.exports=t},function(e,r){e.exports=o}])});
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@leafygreen-ui/badge",
-  "version": "1.1.1",
+  "version": "2.0.0",
   "description": "leafyGreen UI Kit Badge",
@@ -16,6 +16,6 @@ "main": "./dist/index.js",
   "dependencies": {
-    "@leafygreen-ui/lib": "^3.0.1",
-    "@leafygreen-ui/theme": "^1.2.1"
+    "@leafygreen-ui/lib": "^3.0.2",
+    "@leafygreen-ui/palette": "^1.0.2"
   },
-  "gitHead": "5a89ae7074a6e9500cd123c88196f106163c67e6"
+  "gitHead": "dd71a2d404218ccec2e657df9c0263dc1c15b9e0"
 }

README.md

@@ -10,8 +10,5 @@ # Badge
 
-  <Badge
-    variant='lightBlue'
-    className='my-badge'
-  >
-    New
-  </Badge>
+<Badge variant='blue' className='my-badge'>
+  New
+</Badge>
 ```
@@ -22,3 +19,3 @@
 ```HTML
-  <span class="leafygreen-ui-rhgfxf my-badge">New</span>
+  <div class="leafygreen-ui-rhgfxf my-badge">New</div>
 ```
@@ -32,5 +29,5 @@
 
-**Default:** `'default'`
+**Default:** `'lightgray'`
 
-Sets the style variant of the badge. Valid variants for badges are `'default'`, `'danger'`, `'warning'`, `'darkBlue'`, `'lightBlue'`, `'primary'`, `'outline'`, and `'dark'`.
+Sets the style variant of the badge. Valid variants for badges are `'lightgray'`, `'darkgray'`, `'red'`, `'blue'`, `'green'`, and `'yellow'`
 
@@ -37,0 +34,0 @@ ### className

No alert changes

Improved metrics

Lines of code

203

increased by0.5%

Worsened metrics

Total package byte prevSize

66907

decreased by-0.76%

Number of lines in readme file

50

decreased by-5.66%

Dependency changes

• + Added@leafygreen-ui/palette@^1.0.2

• + Added@leafygreen-ui/palette@1.1.1(transitive)

• - Removed@leafygreen-ui/theme@^1.2.1

• - Removed@leafygreen-ui/theme@1.2.6(transitive)

• Updated@leafygreen-ui/lib@^3.0.2