/* * The MIT License (MIT) * * Copyright (c) 2015 - present Instructure, Inc. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ import { useState, useEffect, forwardRef } from 'react' import { useStyle } from '@instructure/emotion' import { callRenderProp, omitProps, useDeterministicId } from '@instructure/ui-react-utils' import { logError as error } from '@instructure/console' import generateStyle from './styles' import type { SpinnerProps } from './props' import { allowedProps } from './props' /** --- category: components --- **/ const Spinner = forwardRef((props, ref) => { const { size = 'medium', variant = 'default', delay, renderTitle, margin, themeOverride } = props const [shouldRender, setShouldRender] = useState(!delay) // Deterministic ID generation const [titleId, setTitleId] = useState() const getId = useDeterministicId('Spinner') useEffect(() => { setTitleId(getId()) }, []) const styles = useStyle({ generateStyle, themeOverride, params: { size, variant, margin }, componentId: 'Spinner', displayName: 'Spinner' }) useEffect(() => { if (delay) { const delayTimeout = setTimeout(() => { setShouldRender(true) }, delay) return () => clearTimeout(delayTimeout) } return undefined }, [delay]) const renderSpinner = () => { error( !!renderTitle, '[Spinner] The `renderTitle` prop is necessary for screen reader support.' ) const passthroughProps = omitProps(props, allowedProps) return (
{callRenderProp(renderTitle)} {variant !== 'inverse' && ( )}
) } return shouldRender ? renderSpinner() : null }) Spinner.displayName = 'Spinner' export default Spinner export { Spinner }