@wordpress/components
Version:
UI components for WordPress.
1 lines • 6.52 kB
Source Map (JSON)
{"version":3,"file":"index.mjs","names":[],"sources":["../../src/notice/index.tsx"],"sourcesContent":["import clsx from 'clsx';\nimport { __ } from '@wordpress/i18n';\nimport { RawHTML, useEffect, renderToString } from '@wordpress/element';\nimport { speak } from '@wordpress/a11y';\nimport { closeSmall } from '@wordpress/icons';\nimport Button from '../button';\nimport type { NoticeAction, NoticeProps } from './types';\nimport type { DeprecatedButtonProps } from '../button/types';\nimport { VisuallyHidden } from '../visually-hidden';\n\nconst noop = () => {};\n\n/**\n * Custom hook which announces the message with the given politeness, if a\n * valid message is provided.\n */\nfunction useSpokenMessage(\n\tmessage: NoticeProps[ 'spokenMessage' ],\n\tpoliteness: NoticeProps[ 'politeness' ]\n) {\n\tconst spokenMessage =\n\t\ttypeof message === 'string' ? message : renderToString( message );\n\n\tuseEffect( () => {\n\t\tif ( spokenMessage ) {\n\t\t\tspeak( spokenMessage, politeness );\n\t\t}\n\t}, [ spokenMessage, politeness ] );\n}\n\nfunction getDefaultPoliteness( status: NoticeProps[ 'status' ] ) {\n\tswitch ( status ) {\n\t\tcase 'success':\n\t\tcase 'warning':\n\t\tcase 'info':\n\t\t\treturn 'polite';\n\t\t// The default will also catch the 'error' status.\n\t\tdefault:\n\t\t\treturn 'assertive';\n\t}\n}\n\nfunction getStatusLabel( status: NoticeProps[ 'status' ] ) {\n\tswitch ( status ) {\n\t\tcase 'warning':\n\t\t\treturn __( 'Warning notice' );\n\t\tcase 'info':\n\t\t\treturn __( 'Information notice' );\n\t\tcase 'error':\n\t\t\treturn __( 'Error notice' );\n\t\t// The default will also catch the 'success' status.\n\t\tdefault:\n\t\t\treturn __( 'Notice' );\n\t}\n}\n\n/**\n * `Notice` is a component used to communicate feedback to the user.\n *\n *```jsx\n * import { Notice } from `@wordpress/components`;\n *\n * const MyNotice = () => (\n * <Notice status=\"error\">An unknown error occurred.</Notice>\n * );\n * ```\n */\nfunction Notice( {\n\tclassName,\n\tstatus = 'info',\n\tchildren,\n\tspokenMessage = children,\n\tonRemove = noop,\n\tisDismissible = true,\n\tactions = [],\n\tpoliteness = getDefaultPoliteness( status ),\n\t__unstableHTML,\n\t// onDismiss is a callback executed when the notice is dismissed.\n\t// It is distinct from onRemove, which _looks_ like a callback but is\n\t// actually the function to call to remove the notice from the UI.\n\tonDismiss = noop,\n}: NoticeProps ) {\n\tuseSpokenMessage( spokenMessage, politeness );\n\n\t// Dismissibility is not a wrapper modifier; target `.components-notice__dismiss`\n\t// or `.components-notice:has(.components-notice__dismiss)` from outside CSS.\n\tconst classes = clsx( className, 'components-notice', 'is-' + status );\n\n\tif ( __unstableHTML && typeof children === 'string' ) {\n\t\tchildren = <RawHTML>{ children }</RawHTML>;\n\t}\n\n\tconst onDismissNotice = () => {\n\t\tonDismiss();\n\t\tonRemove();\n\t};\n\n\treturn (\n\t\t<div className={ classes }>\n\t\t\t<VisuallyHidden>{ getStatusLabel( status ) }</VisuallyHidden>\n\t\t\t<div className=\"components-notice__content\">{ children }</div>\n\t\t\t{ actions.length > 0 && (\n\t\t\t\t<div className=\"components-notice__actions\">\n\t\t\t\t\t{ actions.map(\n\t\t\t\t\t\t(\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tclassName: buttonCustomClasses,\n\t\t\t\t\t\t\t\tlabel,\n\t\t\t\t\t\t\t\tisPrimary,\n\t\t\t\t\t\t\t\tvariant,\n\t\t\t\t\t\t\t\tnoDefaultClasses = false,\n\t\t\t\t\t\t\t\tonClick,\n\t\t\t\t\t\t\t\turl,\n\t\t\t\t\t\t\t\tdisabled,\n\t\t\t\t\t\t\t}: NoticeAction &\n\t\t\t\t\t\t\t\t// `isPrimary` is a legacy prop included for\n\t\t\t\t\t\t\t\t// backcompat, but `variant` should be used\n\t\t\t\t\t\t\t\t// instead.\n\t\t\t\t\t\t\t\tPick< DeprecatedButtonProps, 'isPrimary' >,\n\t\t\t\t\t\t\tindex\n\t\t\t\t\t\t) => {\n\t\t\t\t\t\t\tlet computedVariant = variant;\n\t\t\t\t\t\t\tif ( variant !== 'primary' && ! noDefaultClasses ) {\n\t\t\t\t\t\t\t\tcomputedVariant = ! url ? 'secondary' : 'link';\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\tif (\n\t\t\t\t\t\t\t\ttypeof computedVariant === 'undefined' &&\n\t\t\t\t\t\t\t\tisPrimary\n\t\t\t\t\t\t\t) {\n\t\t\t\t\t\t\t\tcomputedVariant = 'primary';\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\treturn (\n\t\t\t\t\t\t\t\t<Button\n\t\t\t\t\t\t\t\t\tsize=\"compact\"\n\t\t\t\t\t\t\t\t\tkey={ index }\n\t\t\t\t\t\t\t\t\thref={ url }\n\t\t\t\t\t\t\t\t\tvariant={ computedVariant }\n\t\t\t\t\t\t\t\t\tonClick={ onClick }\n\t\t\t\t\t\t\t\t\tdisabled={ disabled }\n\t\t\t\t\t\t\t\t\taccessibleWhenDisabled\n\t\t\t\t\t\t\t\t\tclassName={ clsx(\n\t\t\t\t\t\t\t\t\t\t'components-notice__action',\n\t\t\t\t\t\t\t\t\t\tbuttonCustomClasses\n\t\t\t\t\t\t\t\t\t) }\n\t\t\t\t\t\t\t\t>\n\t\t\t\t\t\t\t\t\t{ label }\n\t\t\t\t\t\t\t\t</Button>\n\t\t\t\t\t\t\t);\n\t\t\t\t\t\t}\n\t\t\t\t\t) }\n\t\t\t\t</div>\n\t\t\t) }\n\t\t\t{ isDismissible && (\n\t\t\t\t<Button\n\t\t\t\t\tsize=\"small\"\n\t\t\t\t\tclassName=\"components-notice__dismiss\"\n\t\t\t\t\ticon={ closeSmall }\n\t\t\t\t\tlabel={ __( 'Close' ) }\n\t\t\t\t\tonClick={ onDismissNotice }\n\t\t\t\t/>\n\t\t\t) }\n\t\t</div>\n\t);\n}\n\nexport default Notice;\n"],"mappings":";;;;;;;;;AAUA,MAAM,aAAa,CAAC;;;;;AAMpB,SAAS,iBACR,SACA,YACC;CACD,MAAM,gBACL,OAAO,YAAY,WAAW,UAAU,eAAgB,OAAQ;CAEjE,gBAAiB;EAChB,IAAK,eACJ,MAAO,eAAe,UAAW;CAEnC,GAAG,CAAE,eAAe,UAAW,CAAE;AAClC;AAEA,SAAS,qBAAsB,QAAkC;CAChE,QAAS,QAAT;EACC,KAAK;EACL,KAAK;EACL,KAAK,QACJ,OAAO;EAER,SACC,OAAO;CACT;AACD;AAEA,SAAS,eAAgB,QAAkC;CAC1D,QAAS,QAAT;EACC,KAAK,WACJ,OAAO,GAAI,gBAAiB;EAC7B,KAAK,QACJ,OAAO,GAAI,oBAAqB;EACjC,KAAK,SACJ,OAAO,GAAI,cAAe;EAE3B,SACC,OAAO,GAAI,QAAS;CACtB;AACD;;;;;;;;;;;;AAaA,SAAS,OAAQ,EAChB,WACA,SAAS,QACT,UACA,gBAAgB,UAChB,WAAW,MACX,gBAAgB,MAChB,UAAU,CAAC,GACX,aAAa,qBAAsB,MAAO,GAC1C,gBAIA,YAAY,QACI;CAChB,iBAAkB,eAAe,UAAW;CAI5C,MAAM,UAAU,KAAM,WAAW,qBAAqB,QAAQ,MAAO;CAErE,IAAK,kBAAkB,OAAO,aAAa,UAC1C,WAAW,oBAAC,SAAD,EAAW,SAAmB,CAAA;CAG1C,MAAM,wBAAwB;EAC7B,UAAU;EACV,SAAS;CACV;CAEA,OACC,qBAAC,OAAD;EAAK,WAAY;EAAjB,UAAA;GACC,oBAAC,gBAAD,EAAA,UAAkB,eAAgB,MAAO,EAAmB,CAAA;GAC5D,oBAAC,OAAD;IAAK,WAAU;IAA+B;GAAe,CAAA;GAC3D,QAAQ,SAAS,KAClB,oBAAC,OAAD;IAAK,WAAU;IACZ,UAAA,QAAQ,KAER,EACC,WAAW,qBACX,OACA,WACA,SACA,mBAAmB,OACnB,SACA,KACA,YAMD,UACI;KACJ,IAAI,kBAAkB;KACtB,IAAK,YAAY,aAAa,CAAE,kBAC/B,kBAAkB,CAAE,MAAM,cAAc;KAEzC,IACC,OAAO,oBAAoB,eAC3B,WAEA,kBAAkB;KAGnB,OACC,oBAAC,QAAD;MACC,MAAK;MAEL,MAAO;MACP,SAAU;MACA;MACC;MACX,wBAAA;MACA,WAAY,KACX,6BACA,mBACD;MAEE,UAAA;KACK,GAZD,KAYC;IAEV,CACD;GACI,CAAA;GAEJ,iBACD,oBAAC,QAAD;IACC,MAAK;IACL,WAAU;IACV,MAAO;IACP,OAAQ,GAAI,OAAQ;IACpB,SAAU;GACV,CAAA;EAEE;;AAEP"}