@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.
286 lines (279 loc) • 9.96 kB
JavaScript
'use client';
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
import _extends from "@babel/runtime/helpers/esm/extends";
const _excluded = ["children", "className", "component", "color", "size", "variant", "thickness", "determinate", "value", "style", "slots", "slotProps"];
import * as React from 'react';
import PropTypes from 'prop-types';
import clsx from 'clsx';
import { unstable_capitalize as capitalize } from '@mui/utils';
import { unstable_composeClasses as composeClasses } from '@mui/base';
import { css, keyframes } from '@mui/system';
import styled from '../styles/styled';
import useThemeProps from '../styles/useThemeProps';
import { getLinearProgressUtilityClass } from './linearProgressClasses';
import useSlot from '../utils/useSlot';
import { resolveSxValue } from '../styles/styleUtils';
// TODO: replace `left` with `inset-inline-start` in the future to work with writing-mode. https://caniuse.com/?search=inset-inline-start
// replace `width` with `inline-size`, not sure why inline-size does not work with animation in Safari.
import { jsx as _jsx } from "react/jsx-runtime";
const progressKeyframe = keyframes`
0% {
left: var(--_LinearProgress-progressInset);
width: var(--LinearProgress-progressMinWidth);
}
25% {
width: var(--LinearProgress-progressMaxWidth);
}
50% {
left: var(--_LinearProgress-progressLeft);
width: var(--LinearProgress-progressMinWidth);
}
75% {
width: var(--LinearProgress-progressMaxWidth);
}
100% {
left: var(--_LinearProgress-progressInset);
width: var(--LinearProgress-progressMinWidth);
}
`;
const useUtilityClasses = ownerState => {
const {
determinate,
color,
variant,
size
} = ownerState;
const slots = {
root: ['root', determinate && 'determinate', color && `color${capitalize(color)}`, variant && `variant${capitalize(variant)}`, size && `size${capitalize(size)}`]
};
return composeClasses(slots, getLinearProgressUtilityClass, {});
};
const LinearProgressRoot = styled('div', {
name: 'JoyLinearProgress',
slot: 'Root',
overridesResolver: (props, styles) => styles.root
})(({
ownerState,
theme
}) => _extends({
// public variables
'--LinearProgress-radius': 'var(--LinearProgress-thickness)',
'--LinearProgress-progressThickness': 'var(--LinearProgress-thickness)',
'--LinearProgress-progressRadius': 'max(var(--LinearProgress-radius) - var(--_LinearProgress-padding), min(var(--_LinearProgress-padding) / 2, var(--LinearProgress-radius) / 2))'
}, ownerState.size === 'sm' && {
'--LinearProgress-thickness': '4px'
}, ownerState.size === 'md' && {
'--LinearProgress-thickness': '6px'
}, ownerState.size === 'lg' && {
'--LinearProgress-thickness': '8px'
}, ownerState.thickness && {
'--LinearProgress-thickness': `${ownerState.thickness}px`
}, !ownerState.determinate && {
'--LinearProgress-progressMinWidth': 'calc(var(--LinearProgress-percent) * 1% / 2)',
'--LinearProgress-progressMaxWidth': 'calc(var(--LinearProgress-percent) * 1%)',
'--_LinearProgress-progressLeft': 'calc(100% - var(--LinearProgress-progressMinWidth) - var(--_LinearProgress-progressInset))',
'--_LinearProgress-progressInset': 'calc(var(--LinearProgress-thickness) / 2 - var(--LinearProgress-progressThickness) / 2)'
}, {
minBlockSize: 'var(--LinearProgress-thickness)',
boxSizing: 'border-box',
borderRadius: 'var(--LinearProgress-radius)',
display: 'flex',
justifyContent: 'center',
alignItems: 'center',
flex: 1,
padding: 'var(--_LinearProgress-padding)',
position: 'relative'
}, theme.variants[ownerState.variant]?.[ownerState.color], {
'--_LinearProgress-padding': 'max((var(--LinearProgress-thickness) - 2 * var(--variant-borderWidth, 0px) - var(--LinearProgress-progressThickness)) / 2, 0px)',
'&::before': {
content: '""',
display: 'block',
boxSizing: 'inherit',
blockSize: 'var(--LinearProgress-progressThickness)',
borderRadius: 'var(--LinearProgress-progressRadius)',
backgroundColor: 'currentColor',
color: 'inherit',
position: 'absolute' // required to make `left` animation works.
}
}, ownerState.variant === 'soft' && {
backgroundColor: theme.variants.soft.neutral.backgroundColor,
color: theme.variants.solid?.[ownerState.color].backgroundColor
}, ownerState.variant === 'solid' && {
backgroundColor: theme.variants.softHover?.[ownerState.color].backgroundColor,
color: theme.variants.solid?.[ownerState.color].backgroundColor
}), ({
ownerState
}) => ownerState.determinate ? {
'&::before': {
left: 'var(--_LinearProgress-padding)',
inlineSize: 'calc(var(--LinearProgress-percent) * 1% - 2 * var(--_LinearProgress-padding))'
}
} : css`
&::before {
animation: ${progressKeyframe}
var(--LinearProgress-circulation, 2.5s ease-in-out 0s infinite normal none running);
}
`, ({
ownerState,
theme
}) => {
const {
borderRadius,
height
} = resolveSxValue({
theme,
ownerState
}, ['borderRadius', 'height']);
return _extends({}, borderRadius !== undefined && {
'--LinearProgress-radius': borderRadius
}, height !== undefined && {
'--LinearProgress-thickness': height
});
});
/**
* ## ARIA
*
* If the progress bar is describing the loading progress of a particular region of a page,
* you should use `aria-describedby` to point to the progress bar, and set the `aria-busy`
* attribute to `true` on that region until it has finished loading.
*
* Demos:
*
* - [Linear Progress](https://mui.com/joy-ui/react-linear-progress/)
*
* API:
*
* - [LinearProgress API](https://mui.com/joy-ui/api/linear-progress/)
*/
const LinearProgress = /*#__PURE__*/React.forwardRef(function LinearProgress(inProps, ref) {
const props = useThemeProps({
props: inProps,
name: 'JoyLinearProgress'
});
const {
children,
className,
component,
color = 'primary',
size = 'md',
variant = 'soft',
thickness,
determinate = false,
value = determinate ? 0 : 25,
// `25` is the 1/4 of the bar.
style,
slots = {},
slotProps = {}
} = props,
other = _objectWithoutPropertiesLoose(props, _excluded);
const ownerState = _extends({}, props, {
component,
color,
size,
variant,
thickness,
value,
determinate,
instanceSize: inProps.size
});
const classes = useUtilityClasses(ownerState);
const externalForwardedProps = _extends({}, other, {
component,
slots,
slotProps
});
const [SlotRoot, rootProps] = useSlot('root', {
ref,
className: clsx(classes.root, className),
elementType: LinearProgressRoot,
externalForwardedProps,
ownerState,
additionalProps: _extends({
as: component,
role: 'progressbar',
style: _extends({}, {
'--LinearProgress-percent': value
}, style)
}, typeof value === 'number' && determinate && {
'aria-valuenow': Math.round(value)
})
});
return /*#__PURE__*/_jsx(SlotRoot, _extends({}, rootProps, {
children: children
}));
});
process.env.NODE_ENV !== "production" ? LinearProgress.propTypes /* remove-proptypes */ = {
// ┌────────────────────────────── Warning ──────────────────────────────┐
// │ These PropTypes are generated from the TypeScript type definitions. │
// │ To update them, edit the TypeScript types and run `pnpm proptypes`. │
// └─────────────────────────────────────────────────────────────────────┘
/**
* @ignore
*/
children: PropTypes.node,
/**
* @ignore
*/
className: PropTypes.string,
/**
* The color of the component. It supports those theme colors that make sense for this component.
* @default 'primary'
*/
color: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([PropTypes.oneOf(['danger', '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 boolean to select a variant.
* Use indeterminate when there is no progress value.
* @default false
*/
determinate: PropTypes.bool,
/**
* The size of the component.
* It accepts theme values between 'sm' and 'lg'.
* @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
}),
/**
* @ignore
*/
style: PropTypes.object,
/**
* 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]),
/**
* The thickness of the bar.
*/
thickness: PropTypes.number,
/**
* The value of the progress indicator for the determinate variant.
* Value between 0 and 100.
*
* @default determinate ? 0 : 25
*/
value: PropTypes.number,
/**
* The [global variant](https://mui.com/joy-ui/main-features/global-variants/) to use.
* @default 'soft'
*/
variant: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([PropTypes.oneOf(['outlined', 'plain', 'soft', 'solid']), PropTypes.string])
} : void 0;
export default LinearProgress;