rsuite 5.75.0 → 5.76.0

package/esm/Carousel/Carousel.js

@@ -134,6 +134,7 @@ var Carousel = /*#__PURE__*/React.forwardRef(function (props, ref) {
   }), /*#__PURE__*/React.createElement("div", {
     className: prefix('content')
   }, /*#__PURE__*/React.createElement("div", {
+    "data-testid": "carousel-slider",
     className: prefix('slider'),
     style: sliderStyles,
     onTransitionEnd: handleTransitionEnd

package/esm/CustomProvider/types.d.ts

@@ -53,6 +53,7 @@ import type { InputProps } from '../Input';
 import type { InputGroupProps } from '../InputGroup';
 import type { InputNumberProps } from '../InputNumber';
 import type { InputPickerProps } from '../InputPicker';
+import type { ImageProps } from '../Image';
 import type { ListProps } from '../List';
 import type { LoaderProps } from '../Loader';
 import type { MaskedInputProps } from '../MaskedInput';
@@ -164,6 +165,7 @@ export interface ReactSuiteComponents {
     InputGroup: ComponentProps<InputGroupProps>;
     InputNumber: ComponentProps<InputNumberProps>;
     InputPicker: ComponentProps<InputPickerProps>;
+    Image: ComponentProps<ImageProps>;
     List: ComponentProps<ListProps>;
     Loader: ComponentProps<LoaderProps>;
     MaskedInput: ComponentProps<MaskedInputProps>;

package/esm/Image/Image.d.ts

@@ -0,0 +1,42 @@
+import React, { CSSProperties } from 'react';
+import type { WithAsProps, RsRefForwardingComponent } from '../internals/types';
+export interface ImageProps extends WithAsProps, Omit<React.ImgHTMLAttributes<HTMLImageElement>, 'placeholder'> {
+    /**
+     * An image may appear with border.
+     */
+    bordered?: boolean;
+    /**
+     * An image may appear circular.
+     */
+    circle?: boolean;
+    /**
+     * The fallback image when the src fails to load.
+     */
+    fallbackSrc?: string;
+    /**
+     * An image may appear rounded.
+     */
+    rounded?: boolean;
+    /**
+     * Whether there is a shadow.
+     */
+    shaded?: boolean;
+    /**
+     * It maps to css `object-fit` property.
+     */
+    fit?: CSSProperties['objectFit'];
+    /**
+     * It maps to css `object-position` property.
+     */
+    position?: CSSProperties['objectPosition'];
+    /**
+     * The placeholder to display when the image is loading.
+     */
+    placeholder?: React.ReactNode;
+    /**
+     * Whether the image should be zoomed when hovered.
+     */
+    zoomed?: boolean;
+}
+declare const Image: RsRefForwardingComponent<'img', ImageProps>;
+export default Image;

package/esm/Image/Image.js

@@ -0,0 +1,97 @@
+'use client';
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+var _excluded = ["as", "bordered", "classPrefix", "className", "circle", "crossOrigin", "fit", "fallbackSrc", "loading", "rounded", "srcSet", "sizes", "shaded", "src", "style", "position", "placeholder", "width", "height", "zoomed"];
+import React from 'react';
+import PropTypes from 'prop-types';
+import { useClassNames } from "../internals/hooks/index.js";
+import { ImageWrapper } from "./ImageWrapper.js";
+import { useImage } from "./hooks/useImage.js";
+import { useCustom } from "../CustomProvider/index.js";
+var Image = /*#__PURE__*/React.forwardRef(function (props, ref) {
+  var _extends2;
+  var _useCustom = useCustom('Image', props),
+    propsWithDefaults = _useCustom.propsWithDefaults;
+  var _propsWithDefaults$as = propsWithDefaults.as,
+    Component = _propsWithDefaults$as === void 0 ? 'img' : _propsWithDefaults$as,
+    bordered = propsWithDefaults.bordered,
+    _propsWithDefaults$cl = propsWithDefaults.classPrefix,
+    classPrefix = _propsWithDefaults$cl === void 0 ? 'image' : _propsWithDefaults$cl,
+    className = propsWithDefaults.className,
+    circle = propsWithDefaults.circle,
+    crossOrigin = propsWithDefaults.crossOrigin,
+    fit = propsWithDefaults.fit,
+    fallbackSrc = propsWithDefaults.fallbackSrc,
+    loading = propsWithDefaults.loading,
+    rounded = propsWithDefaults.rounded,
+    srcSet = propsWithDefaults.srcSet,
+    sizes = propsWithDefaults.sizes,
+    shaded = propsWithDefaults.shaded,
+    src = propsWithDefaults.src,
+    style = propsWithDefaults.style,
+    position = propsWithDefaults.position,
+    placeholder = propsWithDefaults.placeholder,
+    width = propsWithDefaults.width,
+    height = propsWithDefaults.height,
+    zoomed = propsWithDefaults.zoomed,
+    rest = _objectWithoutPropertiesLoose(propsWithDefaults, _excluded);
+  var _useClassNames = useClassNames(classPrefix),
+    merge = _useClassNames.merge,
+    withClassPrefix = _useClassNames.withClassPrefix;
+  var classes = merge(className, withClassPrefix({
+    circle: circle,
+    bordered: bordered,
+    rounded: rounded,
+    shaded: shaded,
+    zoomed: zoomed
+  }));
+  var imgProps = {
+    crossOrigin: crossOrigin,
+    srcSet: srcSet,
+    sizes: sizes,
+    loading: loading
+  };
+  var _useImage = useImage(_extends({
+      src: src,
+      fallbackSrc: fallbackSrc
+    }, imgProps)),
+    imgSrc = _useImage.imgSrc,
+    isLoading = _useImage.isLoading;
+  var styles = _extends({}, style, (_extends2 = {}, _extends2['--rs-object-fit'] = fit, _extends2['--rs-object-position'] = position, _extends2));
+  var wrapStyles = {
+    width: width,
+    height: height
+  };
+  var image = /*#__PURE__*/React.createElement(Component, _extends({
+    ref: ref,
+    src: imgSrc,
+    className: classes,
+    style: styles,
+    width: width,
+    height: height
+  }, imgProps, rest));
+  if (zoomed) {
+    return /*#__PURE__*/React.createElement(ImageWrapper, {
+      style: wrapStyles
+    }, image);
+  }
+  if (placeholder) {
+    return /*#__PURE__*/React.createElement(ImageWrapper, {
+      style: wrapStyles
+    }, isLoading && placeholder, image);
+  }
+  return image;
+});
+Image.displayName = 'Image';
+Image.propTypes = {
+  bordered: PropTypes.bool,
+  circle: PropTypes.bool,
+  fallbackSrc: PropTypes.string,
+  fit: PropTypes.string,
+  position: PropTypes.string,
+  rounded: PropTypes.bool,
+  shaded: PropTypes.bool,
+  placeholder: PropTypes.node,
+  zoomed: PropTypes.bool
+};
+export default Image;

package/esm/Image/ImageWrapper.d.ts

@@ -0,0 +1 @@
+export declare const ImageWrapper: import("../internals/types").RsRefForwardingComponent<"div", import("../internals/utils").ComponentProps>;

package/esm/Image/ImageWrapper.js

@@ -0,0 +1,6 @@
+'use client';
+import { createComponent } from "../internals/utils/index.js";
+export var ImageWrapper = createComponent({
+  name: 'ImageWrapper',
+  componentAs: 'div'
+});

package/esm/Image/hooks/useImage.d.ts

@@ -0,0 +1,14 @@
+interface UseImageProps {
+    src?: string;
+    fallbackSrc?: string;
+    crossOrigin?: string;
+    srcSet?: string;
+    sizes?: string;
+    loading?: 'lazy' | 'eager';
+}
+export declare const useImage: (props: UseImageProps) => {
+    imgSrc: string | null;
+    isLoading: boolean;
+    error: boolean;
+};
+export {};

package/esm/Image/hooks/useImage.js

@@ -0,0 +1,63 @@
+'use client';
+import { useState, useEffect, useRef, useCallback } from 'react';
+import useIsomorphicLayoutEffect from "../../internals/hooks/useIsomorphicLayoutEffect.js";
+export var useImage = function useImage(props) {
+  var src = props.src,
+    fallbackSrc = props.fallbackSrc,
+    crossOrigin = props.crossOrigin,
+    srcSet = props.srcSet,
+    sizes = props.sizes,
+    loading = props.loading;
+  var _useState = useState(src || fallbackSrc || null),
+    imgSrc = _useState[0],
+    setImgSrc = _useState[1];
+  var _useState2 = useState(!!src),
+    isLoading = _useState2[0],
+    setIsLoading = _useState2[1];
+  var _useState3 = useState(false),
+    error = _useState3[0],
+    setError = _useState3[1];
+  var imageRef = useRef(null);
+  useEffect(function () {
+    setIsLoading(!!src); // true if src exists, false otherwise
+  }, [src]);
+  var flush = function flush() {
+    if (imageRef.current) {
+      imageRef.current.onload = null;
+      imageRef.current.onerror = null;
+    }
+  };
+  var loadImage = useCallback(function () {
+    if (!src) return;
+    flush();
+    var image = new Image();
+    image.src = src;
+    if (crossOrigin) image.crossOrigin = crossOrigin;
+    if (srcSet) image.srcset = srcSet;
+    if (sizes) image.sizes = sizes;
+    if (loading) image.loading = loading;
+    image.onload = function () {
+      flush();
+      setImgSrc(src);
+      setIsLoading(false);
+    };
+    image.onerror = function () {
+      flush();
+      setError(true);
+      setImgSrc(fallbackSrc || null);
+      setIsLoading(false);
+    };
+    imageRef.current = image;
+  }, [crossOrigin, fallbackSrc, loading, sizes, src, srcSet]);
+  useIsomorphicLayoutEffect(function () {
+    loadImage();
+    return function () {
+      flush();
+    };
+  }, [loadImage]);
+  return {
+    imgSrc: imgSrc,
+    isLoading: isLoading,
+    error: error
+  };
+};

package/esm/Image/index.d.ts

@@ -0,0 +1,3 @@
+import Image from './Image';
+export type { ImageProps } from './Image';
+export default Image;

package/esm/Image/index.js

@@ -0,0 +1,3 @@
+'use client';
+import Image from "./Image.js";
+export default Image;

package/esm/index.d.ts

@@ -47,6 +47,8 @@ export { default as Avatar } from './Avatar';
 export type { AvatarProps } from './Avatar';
 export { default as AvatarGroup } from './AvatarGroup';
 export type { AvatarGroupProps } from './AvatarGroup';
+export { default as Image } from './Image';
+export type { ImageProps } from './Image';
 export { default as Nav } from './Nav';
 export type { NavProps, NavItemProps } from './Nav';
 export { default as Navbar } from './Navbar';

package/esm/index.js

@@ -34,6 +34,7 @@ export { default as Progress } from "./Progress/index.js";
 // --------------------------------------------------------
 export { default as Avatar } from "./Avatar/index.js";
 export { default as AvatarGroup } from "./AvatarGroup/index.js";
+export { default as Image } from "./Image/index.js";
 // Nav
 // --------------------------------------------------------
 export { default as Nav } from "./Nav/index.js";

package/esm/internals/utils/getDOMNode.js

@@ -2,8 +2,9 @@
 import ReactDOM from 'react-dom';
 function safeFindDOMNode(componentOrElement) {
   if (componentOrElement && 'setState' in componentOrElement) {
+    var _ReactDOM$findDOMNode;
     // eslint-disable-next-line react/no-find-dom-node
-    return ReactDOM.findDOMNode(componentOrElement);
+    return (_ReactDOM$findDOMNode = ReactDOM.findDOMNode) === null || _ReactDOM$findDOMNode === void 0 ? void 0 : _ReactDOM$findDOMNode.call(ReactDOM, componentOrElement);
   }
   return componentOrElement !== null && componentOrElement !== void 0 ? componentOrElement : null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rsuite",
-  "version": "5.75.0",
+  "version": "5.76.0",
   "description": "A suite of react components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/styles/index.less

@@ -40,6 +40,7 @@
 @import '../Header/styles/index';
 @import '../FormHelpText/styles/index';
 @import '../IconButton/styles/index';
+@import '../Image/styles/index';
 @import '../Input/styles/index';
 @import '../InputGroup/styles/index';
 @import '../InputNumber/styles/index';