@base-ui-components/react
Version:
Base UI is a library of headless ('unstyled') React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.
69 lines (68 loc) • 2.42 kB
JavaScript
'use client';
import * as React from 'react';
import PropTypes from 'prop-types';
import { useComponentRenderer } from '../../utils/useComponentRenderer.js';
import { useProgressIndicator } from './useProgressIndicator.js';
import { useProgressRootContext } from '../root/ProgressRootContext.js';
import { progressStyleHookMapping } from '../root/styleHooks.js';
/**
* Visualizes the completion status of the task.
* Renders a `<span>` element.
*
* Documentation: [Base UI Progress](https://base-ui.com/react/components/progress)
*/
const ProgressIndicator = /*#__PURE__*/React.forwardRef(function ProgressIndicator(props, forwardedRef) {
const {
render,
className,
...otherProps
} = props;
const {
max,
min,
value,
state
} = useProgressRootContext();
const {
getRootProps
} = useProgressIndicator({
max,
min,
value
});
const {
renderElement
} = useComponentRenderer({
propGetter: getRootProps,
render: render ?? 'span',
state,
className,
ref: forwardedRef,
extraProps: otherProps,
customStyleHookMapping: progressStyleHookMapping
});
return renderElement();
});
process.env.NODE_ENV !== "production" ? ProgressIndicator.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,
/**
* CSS class applied to the element, or a function that
* returns a class based on the component’s state.
*/
className: PropTypes.oneOfType([PropTypes.func, PropTypes.string]),
/**
* Allows you to replace the component’s HTML element
* with a different tag, or compose it with another component.
*
* Accepts a `ReactElement` or a function that returns the element to render.
*/
render: PropTypes.oneOfType([PropTypes.element, PropTypes.func])
} : void 0;
export { ProgressIndicator };