/* * 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 { Component } from 'react' import { View } from '@instructure/ui-view/v11_6' import { callRenderProp, omitProps, withDeterministicId } from '@instructure/ui-react-utils' import { logError as error } from '@instructure/console' import { withStyleLegacy as withStyle } from '@instructure/emotion' import generateStyle from './styles' import generateComponentTheme from './theme' import type { SpinnerProps, SpinnerState } from './props' import { allowedProps } from './props' /** --- category: components --- **/ @withDeterministicId() @withStyle(generateStyle, generateComponentTheme) class Spinner extends Component { static readonly componentId = 'Spinner' static allowedProps = allowedProps static defaultProps = { as: 'div', size: 'medium', variant: 'default' } ref: Element | null = null private readonly titleId?: string private delayTimeout?: NodeJS.Timeout handleRef = (el: Element | null) => { const { elementRef } = this.props this.ref = el if (typeof elementRef === 'function') { elementRef(el) } } constructor(props: SpinnerProps) { super(props) this.titleId = props.deterministicId!() this.state = { shouldRender: !props.delay } } componentDidMount() { this.props.makeStyles?.() const { delay } = this.props if (delay) { this.delayTimeout = setTimeout(() => { this.setState({ shouldRender: true }) }, delay) } } componentDidUpdate() { this.props.makeStyles?.() } componentWillUnmount() { clearTimeout(this.delayTimeout) } radius() { switch (this.props.size) { case 'x-small': return '0.5em' case 'small': return '1em' case 'large': return '2.25em' default: return '1.75em' } } renderSpinner() { const passthroughProps = View.omitViewProps( omitProps(this.props, Spinner.allowedProps), Spinner ) const hasTitle = this.props.renderTitle error( !!hasTitle, '[Spinner] The renderTitle prop is necessary for screen reader support.' ) return ( {callRenderProp(this.props.renderTitle)} {this.props.variant !== 'inverse' && ( )} ) } render() { return this.state.shouldRender ? this.renderSpinner() : null } } export default Spinner export { Spinner }