@scm-manager/ui-buttons 2.43.1 → 2.43.2-20230425-175303

package/build/index.d.ts

@@ -18,25 +18,56 @@ declare type BaseButtonProps = {
     testId?: string;
 };
 /**
- * Styled html button
+ * Styled html button.
+ *
+ * A button has to declare an `aria-label` if it exclusively contains an {@link Icon} as its children.
  *
  * @beta
  * @since 2.41.0
  */
 declare const Button: React.ForwardRefExoticComponent<BaseButtonProps & React.ButtonHTMLAttributes<HTMLButtonElement> & React.RefAttributes<HTMLButtonElement>>;
 /**
- * Styled react router link
+ * Styled react router link.
+ *
+ * A button has to declare an `aria-label` if it exclusively contains an {@link Icon} as its children.
  *
  * @beta
  * @since 2.41.0
  */
 declare const LinkButton: React.ForwardRefExoticComponent<BaseButtonProps & LinkProps<unknown> & React.RefAttributes<HTMLAnchorElement>>;
 /**
- * Styled html anchor
+ * External links open in a new browser tab with rel flags "noopener" and "noreferrer" set by default.
+ *
+ * @beta
+ * @since 2.44.0
+ */
+declare const ExternalLink: React.ForwardRefExoticComponent<React.AnchorHTMLAttributes<HTMLAnchorElement> & React.RefAttributes<HTMLAnchorElement>>;
+/**
+ * Styled {@link ExternalLink}.
+ *
+ * A button has to declare an `aria-label` if it exclusively contains an {@link Icon} as its children.
  *
  * @beta
  * @since 2.41.0
+ * @see ExternalLink
  */
 declare const ExternalLinkButton: React.ForwardRefExoticComponent<BaseButtonProps & React.AnchorHTMLAttributes<HTMLAnchorElement> & React.RefAttributes<HTMLAnchorElement>>;
 
-export { Button, ButtonVariants, ExternalLinkButton, LinkButton };
+declare type Props = React.HTMLProps<HTMLElement> & {
+    children?: string;
+};
+/**
+ * Icons are hidden to assistive technologies by default.
+ *
+ * If your icon does convey a state, unset `aria-hidden` and set an appropriate `aria-label`.
+ *
+ * The children have to be a single text node containing a valid fontawesome icon name.
+ *
+ * @beta
+ * @since 2.44.0
+ * @see https://bulma.io/documentation/elements/icon/
+ * @see https://fontawesome.com/search?o=r&m=free
+ */
+declare const Icon: React.ForwardRefExoticComponent<Pick<Props, "children" | "cite" | "data" | "form" | "label" | "slot" | "span" | "style" | "summary" | "title" | "pattern" | "default" | "type" | "className" | "key" | "dateTime" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "list" | "as" | "name" | "alt" | "src" | "href" | "disabled" | "action" | "download" | "hrefLang" | "media" | "rel" | "target" | "value" | "size" | "open" | "step" | "autoFocus" | "formAction" | "formEncType" | "formMethod" | "formNoValidate" | "formTarget" | "height" | "max" | "method" | "min" | "width" | "crossOrigin" | "classID" | "useMap" | "wmode" | "coords" | "shape" | "autoPlay" | "controls" | "loop" | "mediaGroup" | "muted" | "playsInline" | "preload" | "acceptCharset" | "autoComplete" | "encType" | "noValidate" | "manifest" | "allowFullScreen" | "allowTransparency" | "frameBorder" | "marginHeight" | "marginWidth" | "sandbox" | "scrolling" | "seamless" | "srcDoc" | "sizes" | "srcSet" | "async" | "accept" | "capture" | "checked" | "maxLength" | "minLength" | "multiple" | "readOnly" | "required" | "challenge" | "keyType" | "keyParams" | "htmlFor" | "integrity" | "charSet" | "content" | "httpEquiv" | "high" | "low" | "optimum" | "reversed" | "start" | "selected" | "defer" | "nonce" | "scoped" | "cellPadding" | "cellSpacing" | "colSpan" | "headers" | "rowSpan" | "scope" | "cols" | "rows" | "wrap" | "kind" | "srcLang" | "poster"> & React.RefAttributes<HTMLElement>>;
+
+export { Button, ButtonVariants, ExternalLink, ExternalLinkButton, Icon, LinkButton };

package/build/index.js

@@ -28,7 +28,9 @@ var src_exports = {};
 __export(src_exports, {
   Button: () => Button,
   ButtonVariants: () => ButtonVariants,
+  ExternalLink: () => ExternalLink,
   ExternalLinkButton: () => ExternalLinkButton,
+  Icon: () => Icon_default,
   LinkButton: () => LinkButton
 });
 module.exports = __toCommonJS(src_exports);
@@ -69,18 +71,47 @@ var LinkButton = import_react.default.forwardRef(
     ...(0, import_ui_components.createAttributesForTesting)(testId)
   }, children)
 );
+var ExternalLink = import_react.default.forwardRef(
+  ({ children, ...props }, ref) => /* @__PURE__ */ import_react.default.createElement("a", {
+    target: "_blank",
+    rel: "noreferrer noopener",
+    ...props,
+    ref
+  }, children)
+);
 var ExternalLinkButton = import_react.default.forwardRef(
-  ({ className, variant, isLoading, testId, children, ...props }, ref) => /* @__PURE__ */ import_react.default.createElement("a", {
+  ({ className, variant, isLoading, testId, children, ...props }, ref) => /* @__PURE__ */ import_react.default.createElement(ExternalLink, {
     ...props,
     className: (0, import_classnames.default)(createButtonClasses(variant, isLoading), className),
     ref,
     ...(0, import_ui_components.createAttributesForTesting)(testId)
   }, children)
 );
+
+// src/Icon.tsx
+var import_react2 = __toESM(require("react"));
+var import_classnames2 = __toESM(require("classnames"));
+var Icon = import_react2.default.forwardRef(({ children, className, ...props }, ref) => {
+  return /* @__PURE__ */ import_react2.default.createElement("span", {
+    className: (0, import_classnames2.default)(className, "icon"),
+    "aria-hidden": "true",
+    ...props,
+    ref
+  }, /* @__PURE__ */ import_react2.default.createElement("i", {
+    className: (0, import_classnames2.default)(`fas fa-fw fa-${children}`, {
+      "fa-xs": className == null ? void 0 : className.includes("is-small"),
+      "fa-lg": className == null ? void 0 : className.includes("is-medium"),
+      "fa-2x": className == null ? void 0 : className.includes("is-large")
+    })
+  }));
+});
+var Icon_default = Icon;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Button,
   ButtonVariants,
+  ExternalLink,
   ExternalLinkButton,
+  Icon,
   LinkButton
 });

package/build/index.mjs

@@ -34,17 +34,46 @@ var LinkButton = React.forwardRef(
     ...createAttributesForTesting(testId)
   }, children)
 );
+var ExternalLink = React.forwardRef(
+  ({ children, ...props }, ref) => /* @__PURE__ */ React.createElement("a", {
+    target: "_blank",
+    rel: "noreferrer noopener",
+    ...props,
+    ref
+  }, children)
+);
 var ExternalLinkButton = React.forwardRef(
-  ({ className, variant, isLoading, testId, children, ...props }, ref) => /* @__PURE__ */ React.createElement("a", {
+  ({ className, variant, isLoading, testId, children, ...props }, ref) => /* @__PURE__ */ React.createElement(ExternalLink, {
     ...props,
     className: classNames(createButtonClasses(variant, isLoading), className),
     ref,
     ...createAttributesForTesting(testId)
   }, children)
 );
+
+// src/Icon.tsx
+import React2 from "react";
+import classNames2 from "classnames";
+var Icon = React2.forwardRef(({ children, className, ...props }, ref) => {
+  return /* @__PURE__ */ React2.createElement("span", {
+    className: classNames2(className, "icon"),
+    "aria-hidden": "true",
+    ...props,
+    ref
+  }, /* @__PURE__ */ React2.createElement("i", {
+    className: classNames2(`fas fa-fw fa-${children}`, {
+      "fa-xs": className == null ? void 0 : className.includes("is-small"),
+      "fa-lg": className == null ? void 0 : className.includes("is-medium"),
+      "fa-2x": className == null ? void 0 : className.includes("is-large")
+    })
+  }));
+});
+var Icon_default = Icon;
 export {
   Button,
   ButtonVariants,
+  ExternalLink,
   ExternalLinkButton,
+  Icon_default as Icon,
   LinkButton
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scm-manager/ui-buttons",
-  "version": "2.43.1",
+  "version": "2.43.2-20230425-175303",
   "private": false,
   "main": "build/index.js",
   "module": "build/index.mjs",
@@ -24,11 +24,11 @@
     "react-dom": "^17.0.1",
     "react-router-dom": "^5.3.1",
     "classnames": "^2.2.6",
-    "@scm-manager/ui-components": "2.43.1"
+    "@scm-manager/ui-components": "2.43.2-20230425-175303"
   },
   "devDependencies": {
     "@scm-manager/prettier-config": "^2.11.1",
-    "@scm-manager/ui-api": "2.43.1",
+    "@scm-manager/ui-api": "2.43.2-20230425-175303",
     "@scm-manager/eslint-config": "^2.17.0",
     "@babel/core": "^7.17.8",
     "@scm-manager/tsconfig": "^2.12.0",