@mui/joy
Version:
Joy UI is an open-source React component library that implements MUI's own design principles. It's comprehensive and can be used in production out of the box.
219 lines (218 loc) • 8.13 kB
JavaScript
'use client';
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
import _extends from "@babel/runtime/helpers/esm/extends";
const _excluded = ["children", "className", "color", "component", "fontSize", "htmlColor", "inheritViewBox", "titleAccess", "viewBox", "size", "slots", "slotProps"];
import { unstable_composeClasses as composeClasses } from '@mui/base';
import { unstable_capitalize as capitalize } from '@mui/utils';
import clsx from 'clsx';
import PropTypes from 'prop-types';
import * as React from 'react';
import styled from '../styles/styled';
import useThemeProps from '../styles/useThemeProps';
import useSlot from '../utils/useSlot';
import { getSvgIconUtilityClass } from './svgIconClasses';
import { jsx as _jsx } from "react/jsx-runtime";
import { jsxs as _jsxs } from "react/jsx-runtime";
const useUtilityClasses = ownerState => {
const {
color,
size,
fontSize
} = ownerState;
const slots = {
root: ['root', color && color !== 'inherit' && `color${capitalize(color)}`, size && `size${capitalize(size)}`, fontSize && `fontSize${capitalize(fontSize)}`]
};
return composeClasses(slots, getSvgIconUtilityClass, {});
};
const sizeMap = {
sm: 'xl',
md: 'xl2',
lg: 'xl3'
};
const SvgIconRoot = styled('svg', {
name: 'JoySvgIcon',
slot: 'Root',
overridesResolver: (props, styles) => styles.root
})(({
theme,
ownerState
}) => _extends({}, ownerState.instanceSize && {
'--Icon-fontSize': theme.vars.fontSize[sizeMap[ownerState.instanceSize]]
}, ownerState.instanceFontSize && ownerState.instanceFontSize !== 'inherit' && {
'--Icon-fontSize': theme.vars.fontSize[ownerState.instanceFontSize]
}, {
userSelect: 'none',
margin: 'var(--Icon-margin)',
width: '1em',
height: '1em',
display: 'inline-block',
// the <svg> will define the property that has `currentColor`
// for example heroicons uses fill="none" and stroke="currentColor"
fill: ownerState.hasSvgAsChild ? undefined : 'currentColor',
flexShrink: 0,
fontSize: `var(--Icon-fontSize, ${theme.vars.fontSize[sizeMap[ownerState.size]] || 'unset'})`
}, ownerState.fontSize && ownerState.fontSize !== 'inherit' && {
fontSize: `var(--Icon-fontSize, ${theme.fontSize[ownerState.fontSize]})`
}, !ownerState.htmlColor && _extends({
color: `var(--Icon-color, ${theme.vars.palette.text.icon})`
}, ownerState.color === 'inherit' && {
color: 'inherit'
}, ownerState.color !== 'inherit' && theme.vars.palette[ownerState.color] && {
color: `rgba(${theme.vars.palette[ownerState.color]?.mainChannel} / 1)`
})));
/**
*
* Demos:
*
* - [Avatar](https://mui.com/joy-ui/react-avatar/)
*
* API:
*
* - [SvgIcon API](https://mui.com/joy-ui/api/svg-icon/)
*/
const SvgIcon = /*#__PURE__*/React.forwardRef(function SvgIcon(inProps, ref) {
const props = useThemeProps({
props: inProps,
name: 'JoySvgIcon'
});
const {
children,
className,
color,
component = 'svg',
fontSize,
htmlColor,
inheritViewBox = false,
titleAccess,
viewBox = '0 0 24 24',
size = 'md',
slots = {},
slotProps = {}
} = props,
other = _objectWithoutPropertiesLoose(props, _excluded);
const hasSvgAsChild = /*#__PURE__*/React.isValidElement(children) && children.type === 'svg';
const ownerState = _extends({}, props, {
color,
component,
size,
instanceSize: inProps.size,
fontSize,
instanceFontSize: inProps.fontSize,
inheritViewBox,
viewBox,
hasSvgAsChild
});
const classes = useUtilityClasses(ownerState);
const externalForwardedProps = _extends({}, other, {
component,
slots,
slotProps
});
const [SlotRoot, rootProps] = useSlot('root', {
ref,
className: clsx(classes.root, className),
elementType: SvgIconRoot,
externalForwardedProps,
ownerState,
additionalProps: _extends({
color: htmlColor,
focusable: false
}, titleAccess && {
role: 'img'
}, !titleAccess && {
'aria-hidden': true
}, !inheritViewBox && {
viewBox
}, hasSvgAsChild && children.props)
});
return /*#__PURE__*/_jsxs(SlotRoot, _extends({}, rootProps, {
children: [hasSvgAsChild ? children.props.children : children, titleAccess ? /*#__PURE__*/_jsx("title", {
children: titleAccess
}) : null]
}));
});
process.env.NODE_ENV !== "production" ? SvgIcon.propTypes /* remove-proptypes */ = {
// ┌────────────────────────────── Warning ──────────────────────────────┐
// │ These PropTypes are generated from the TypeScript type definitions. │
// │ To update them, edit the TypeScript types and run `pnpm proptypes`. │
// └─────────────────────────────────────────────────────────────────────┘
/**
* Node passed into the SVG element.
*/
children: PropTypes.node,
/**
* @ignore
*/
className: PropTypes.string,
/**
* The color of the component. It supports those theme colors that make sense for this component.
* You can use the `htmlColor` prop to apply a color attribute to the SVG element.
*/
color: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([PropTypes.oneOf(['danger', 'inherit', 'neutral', 'primary', 'success', 'warning']), PropTypes.string]),
/**
* The component used for the root node.
* Either a string to use a HTML element or a component.
*/
component: PropTypes.elementType,
/**
* The theme's fontSize applied to the icon that will override the `size` prop.
* Use this prop when you want to use a specific font-size from the theme.
*/
fontSize: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([PropTypes.oneOf(['inherit', 'lg', 'md', 'sm', 'xl', 'xl2', 'xl3', 'xl4', 'xs']), PropTypes.string]),
/**
* Applies a color attribute to the SVG element.
*/
htmlColor: PropTypes.string,
/**
* If `true`, the root node will inherit the custom `component`'s viewBox and the `viewBox`
* prop will be ignored.
* Useful when you want to reference a custom `component` and have `SvgIcon` pass that
* `component`'s viewBox to the root node.
* @default false
*/
inheritViewBox: PropTypes.bool,
/**
* The shape-rendering attribute. The behavior of the different options is described on the
* [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/shape-rendering).
* If you are having issues with blurry icons you should investigate this prop.
*/
shapeRendering: PropTypes.string,
/**
* The size of the component.
* @default 'md'
*/
size: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([PropTypes.oneOf(['sm', 'md', 'lg']), PropTypes.string]),
/**
* The props used for each slot inside.
* @default {}
*/
slotProps: PropTypes.shape({
root: PropTypes.oneOfType([PropTypes.func, PropTypes.object])
}),
/**
* The components used for each slot inside.
* @default {}
*/
slots: PropTypes.shape({
root: PropTypes.elementType
}),
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
/**
* Provides a human-readable title for the element that contains it.
* https://www.w3.org/TR/SVG-access/#Equivalent
*/
titleAccess: PropTypes.string,
/**
* Allows you to redefine what the coordinates without units mean inside an SVG element.
* For example, if the SVG element is 500 (width) by 200 (height),
* and you pass viewBox="0 0 50 20",
* this means that the coordinates inside the SVG will go from the top left corner (0,0)
* to bottom right (50,20) and each unit will be worth 10px.
* @default '0 0 24 24'
*/
viewBox: PropTypes.string
} : void 0;
export default SvgIcon;