/* * 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 { omitProps, withDeterministicId } from '@instructure/ui-react-utils' import { combineDataCid } from '@instructure/ui-utils' import { withStyle } from '@instructure/emotion' import generateStyle from './styles' import generateComponentTheme from './theme' import { allowedProps } from './props' import type { InlineSVGProps } from './props' /** --- category: components/utilities --- **/ @withDeterministicId() @withStyle(generateStyle, generateComponentTheme) class InlineSVG extends Component { static readonly componentId = 'InlineSVG' static allowedProps = allowedProps static defaultProps = { focusable: false, src: '', title: '', description: '', inline: true, width: '1em', height: '1em', color: 'inherit' } titleId?: string descId?: string ref: Element | null = null handleRef = (el: Element | null) => { const { elementRef } = this.props this.ref = el if (typeof elementRef === 'function') { elementRef(el) } } constructor(props: InlineSVGProps) { super(props) this.titleId = props.deterministicId!('InlineSVG-title') this.descId = props.deterministicId!('InlineSVG-desc') } componentDidMount() { this.props.makeStyles?.() } componentDidUpdate() { this.props.makeStyles?.() } static prepareSrc = (src: string) => { const pattern = /]*>((.|[\n\r])*)<\/svg>/ const matches = pattern.exec(src) return matches ? matches[1] : src } get role() { if (this.props.title) { return 'img' } else { return 'presentation' } } renderTitle() { const { title } = this.props return title ? {title} : null } renderDesc(desc: InlineSVGProps['description']) { return desc ? {desc} : null } get labelledBy() { const ids: string[] = [] if (this.props.title) { ids.push(this.titleId as string) } if (this.props.description) { ids.push(this.descId as string) } return ids.length > 0 ? ids.join(' ') : undefined } renderContent() { if (this.props.src) { const src = InlineSVG.prepareSrc(this.props.src) return ( ) } else { return {this.props.children} } } // Firefox workaround: If width/height is a string that's a number (e.g. '100') // it needs to be converted to a number, otherwise it is not added to the // stylesheet numberToNumberType(n: string | number | undefined) { if (typeof n === 'string') { const parsed = parseFloat(n) // from https://stackoverflow.com/a/52986361/319473 if (!isNaN(parsed) && isFinite(n as unknown as number)) { return parsed } } return n } render() { const { style, title, description, focusable, src, styles, ...props } = this.props // if width or height are 'auto', don't supply anything to the SVG const width = this.props.width === 'auto' ? undefined : this.numberToNumberType(this.props.width) const height = this.props.height === 'auto' ? undefined : this.numberToNumberType(this.props.height) return ( {this.renderTitle()} {this.renderDesc(description)} {this.renderContent()} ) } } function parseAttributes(src: InlineSVGProps['src']) { const attributes: Record = {} const SVGAttributesRegExp = /]*)\s*>/ // Match either quoted or unquoted attribute values // Handles both standard format: attr="value" and non-standard: attr=value // (\S+?) = attribute name, (?:["']([^"']*)["']|(\S+)) = quoted (group 2) OR unquoted (group 3) value const namesAndValuesRegExp = /(\S+?)=(?:["']([^"']*)["']|(\S+))/g if (typeof src === 'string') { const attributesMatches = SVGAttributesRegExp.exec(src) const attributesString = attributesMatches ? attributesMatches[1] : '' const excludes = ['xmlns', 'xmlns:xlink', 'version'] let match = namesAndValuesRegExp.exec(attributesString) while (match != null) { if (excludes.indexOf(match[1]) === -1) { // match[1] = attribute name, match[2] = quoted value, match[3] = unquoted value attributes[match[1]] = match[2] || match[3] } match = namesAndValuesRegExp.exec(attributesString) } } return attributes } export default InlineSVG export { InlineSVG }