/* * 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 { ComponentElement, Children, Component } from 'react' import { safeCloneElement, passthroughProps, matchComponentTypes, callRenderProp } from '@instructure/ui-react-utils' import { View } from '@instructure/ui-view/latest' import { withStyleNew } from '@instructure/emotion' import { Item } from './Item' import type { FlexItemProps } from './Item/props' import generateStyle from './styles' import { allowedProps } from './props' import type { FlexProps } from './props' /** --- category: components --- @module Flex **/ @withStyleNew(generateStyle) class Flex extends Component { static readonly componentId = 'Flex' componentDidMount() { this.props.makeStyles?.() } componentDidUpdate() { this.props.makeStyles?.() } static Item = Item static allowedProps = allowedProps static defaultProps = { as: 'span', direction: 'row', justifyItems: 'start', display: 'flex', withVisualDebug: false, wrap: 'no-wrap', gap: 'none' } ref: Element | null = null handleRef = (el: Element | null) => { const { elementRef } = this.props this.ref = el if (typeof elementRef === 'function') { elementRef(el) } } renderChildren(children: FlexProps['children']) { // TODO this might fail if children are () => ReactNode return Children.map(children as React.ReactNode, (child) => { if (!child) { return null } return matchComponentTypes>(child, [ 'Item' ]) ? safeCloneElement(child, { // child withVisualDebug prop should override parent withVisualDebug: this.props.withVisualDebug, ...child.props, direction: this.props.direction!.replace( /-reverse/, '' ) as FlexItemProps['direction'] }) : child }) } render() { const { as, withVisualDebug, height, display, margin, padding, textAlign, width, styles, gap, wrap } = this.props const children = callRenderProp(this.props.children) const gapValuesArray = gap?.split(' ') if (gapValuesArray!.length > 1 && wrap === 'no-wrap') console.warn( 'The `gap` prop is supplied with an improper `wrap=no-wrap` prop.' ) if (children && Children.count(children) > 0) { return ( {this.renderChildren(children)} ) } else { return null } } } export default Flex export { Flex, Item as FlexItem }