carbon-react 114.11.0 → 114.12.0

package/esm/components/image/image.component.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { StyledImageProps } from "./image.style";
 export declare const Image: {
-    ({ alt, src, children, ...rest }: StyledImageProps): JSX.Element;
+    ({ alt, decorative, src, children, ...rest }: StyledImageProps): JSX.Element;
     displayName: string;
 };
 export default Image;

package/esm/components/image/image.component.js

@@ -7,14 +7,16 @@ import { StyledImage } from "./image.style";
 
 const Image = ({
   alt,
+  decorative = false,
   src,
   children,
   ...rest
 }) => {
   !(!src || !children) ? process.env.NODE_ENV !== "production" ? invariant(false, "The 'Image' component renders as an 'img' element when the 'src' prop is used and therefore does not accept children.") : invariant(false) : void 0;
-  !(!src || alt && typeof alt === "string") ? process.env.NODE_ENV !== "production" ? invariant(false, "Please provide an 'alt' string when rendering the 'Image' component as an 'img' element.") : invariant(false) : void 0;
+  !(!src || alt && typeof alt === "string" || decorative) ? process.env.NODE_ENV !== "production" ? invariant(false, "Please use the 'decorative' prop if the 'alt' text should be an empty value or provide an 'alt' string when rendering the 'Image' component as an 'img' element.") : invariant(false) : void 0;
   return /*#__PURE__*/React.createElement(StyledImage, _extends({
     alt: alt,
+    decorative: decorative,
     src: src
   }, rest), children);
 };
@@ -527,6 +529,7 @@ Image.propTypes = {
     "valueOf": PropTypes.func.isRequired
   }), PropTypes.string]),
   "children": PropTypes.node,
+  "decorative": PropTypes.bool,
   "display": PropTypes.oneOfType([PropTypes.oneOf(["-moz-initial", "-ms-flexbox", "-ms-grid", "-ms-inline-flexbox", "-ms-inline-grid", "-webkit-flex", "-webkit-inline-flex", "block", "contents", "flex", "flow-root", "flow", "grid", "inherit", "initial", "inline-block", "inline-flex", "inline-grid", "inline-list-item", "inline-table", "inline", "list-item", "none", "revert", "ruby-base-container", "ruby-base", "ruby-text-container", "ruby-text", "ruby", "run-in", "table-caption", "table-cell", "table-column-group", "table-column", "table-footer-group", "table-header-group", "table-row-group", "table-row", "table", "unset"]), PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf(["-moz-initial", "-ms-flexbox", "-ms-grid", "-ms-inline-flexbox", "-ms-inline-grid", "-webkit-flex", "-webkit-inline-flex", "block", "contents", "flex", "flow-root", "flow", "grid", "inherit", "initial", "inline-block", "inline-flex", "inline-grid", "inline-list-item", "inline-table", "inline", "list-item", "none", "revert", "ruby-base-container", "ruby-base", "ruby-text-container", "ruby-text", "ruby", "run-in", "table-caption", "table-cell", "table-column-group", "table-column", "table-footer-group", "table-header-group", "table-row-group", "table-row", "table", "unset", null]), PropTypes.shape({
     "__@iterator": PropTypes.func.isRequired,
     "anchor": PropTypes.func.isRequired,

package/esm/components/image/image.style.d.ts

@@ -3,6 +3,8 @@ import { MarginProps, BackgroundProps, LayoutProps } from "styled-system";
 export interface StyledImageProps extends MarginProps, BackgroundProps, LayoutProps {
     /** HTML alt property to display when an img fails to load */
     alt?: string;
+    /** Prop to specify if the image is decorative  */
+    decorative?: boolean;
     /** Any valid file path, passing this will render the component as an img element */
     src?: string;
     /** HTML hidden property to indicate whether to remain hidden visually and from screen readers */

package/lib/components/image/image.component.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { StyledImageProps } from "./image.style";
 export declare const Image: {
-    ({ alt, src, children, ...rest }: StyledImageProps): JSX.Element;
+    ({ alt, decorative, src, children, ...rest }: StyledImageProps): JSX.Element;
     displayName: string;
 };
 export default Image;

package/lib/components/image/image.component.js

@@ -19,14 +19,16 @@ function _extends() { _extends = Object.assign || function (target) { for (var i
 
 const Image = ({
   alt,
+  decorative = false,
   src,
   children,
   ...rest
 }) => {
   !(!src || !children) ? process.env.NODE_ENV !== "production" ? (0, _invariant.default)(false, "The 'Image' component renders as an 'img' element when the 'src' prop is used and therefore does not accept children.") : (0, _invariant.default)(false) : void 0;
-  !(!src || alt && typeof alt === "string") ? process.env.NODE_ENV !== "production" ? (0, _invariant.default)(false, "Please provide an 'alt' string when rendering the 'Image' component as an 'img' element.") : (0, _invariant.default)(false) : void 0;
+  !(!src || alt && typeof alt === "string" || decorative) ? process.env.NODE_ENV !== "production" ? (0, _invariant.default)(false, "Please use the 'decorative' prop if the 'alt' text should be an empty value or provide an 'alt' string when rendering the 'Image' component as an 'img' element.") : (0, _invariant.default)(false) : void 0;
   return /*#__PURE__*/_react.default.createElement(_image.StyledImage, _extends({
     alt: alt,
+    decorative: decorative,
     src: src
   }, rest), children);
 };
@@ -540,6 +542,7 @@ Image.propTypes = {
     "valueOf": _propTypes.default.func.isRequired
   }), _propTypes.default.string]),
   "children": _propTypes.default.node,
+  "decorative": _propTypes.default.bool,
   "display": _propTypes.default.oneOfType([_propTypes.default.oneOf(["-moz-initial", "-ms-flexbox", "-ms-grid", "-ms-inline-flexbox", "-ms-inline-grid", "-webkit-flex", "-webkit-inline-flex", "block", "contents", "flex", "flow-root", "flow", "grid", "inherit", "initial", "inline-block", "inline-flex", "inline-grid", "inline-list-item", "inline-table", "inline", "list-item", "none", "revert", "ruby-base-container", "ruby-base", "ruby-text-container", "ruby-text", "ruby", "run-in", "table-caption", "table-cell", "table-column-group", "table-column", "table-footer-group", "table-header-group", "table-row-group", "table-row", "table", "unset"]), _propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.oneOf(["-moz-initial", "-ms-flexbox", "-ms-grid", "-ms-inline-flexbox", "-ms-inline-grid", "-webkit-flex", "-webkit-inline-flex", "block", "contents", "flex", "flow-root", "flow", "grid", "inherit", "initial", "inline-block", "inline-flex", "inline-grid", "inline-list-item", "inline-table", "inline", "list-item", "none", "revert", "ruby-base-container", "ruby-base", "ruby-text-container", "ruby-text", "ruby", "run-in", "table-caption", "table-cell", "table-column-group", "table-column", "table-footer-group", "table-header-group", "table-row-group", "table-row", "table", "unset", null]), _propTypes.default.shape({
     "__@iterator": _propTypes.default.func.isRequired,
     "anchor": _propTypes.default.func.isRequired,

package/lib/components/image/image.style.d.ts

@@ -3,6 +3,8 @@ import { MarginProps, BackgroundProps, LayoutProps } from "styled-system";
 export interface StyledImageProps extends MarginProps, BackgroundProps, LayoutProps {
     /** HTML alt property to display when an img fails to load */
     alt?: string;
+    /** Prop to specify if the image is decorative  */
+    decorative?: boolean;
     /** Any valid file path, passing this will render the component as an img element */
     src?: string;
     /** HTML hidden property to indicate whether to remain hidden visually and from screen readers */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "carbon-react",
-  "version": "114.11.0",
+  "version": "114.12.0",
   "description": "A library of reusable React components for easily building user interfaces.",
   "files": [
     "lib",