@instructure/ui-color-picker 8.25.1-snapshot-20

package/src/ColorMixer/RGBAInput/index.tsx

@@ -0,0 +1,172 @@
+/*
+ * 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.
+ */
+
+/** @jsx jsx */
+import React, { Component } from 'react'
+
+import { withStyle, jsx } from '@instructure/emotion'
+import shallowCompare from '../utils/shallowCompare'
+
+import { ScreenReaderContent } from '@instructure/ui-a11y-content'
+import { TextInput } from '@instructure/ui-text-input'
+
+import { propTypes, allowedProps } from './props'
+import type { RGBAInputProps, RGBAInputState } from './props'
+
+import generateStyle from './styles'
+import generateComponentTheme from './theme'
+
+/**
+ * ---
+ * private: true
+ * ---
+ * @tsProps
+ **/
+@withStyle(generateStyle, generateComponentTheme)
+class RGBAInput extends Component<RGBAInputProps, RGBAInputState> {
+  static propTypes = propTypes
+  static allowedProps = allowedProps
+  static readonly componentId = 'ColorMixer.RGBAInput'
+
+  constructor(props: RGBAInputProps) {
+    super(props)
+    this.state = {
+      value: props.value
+    }
+  }
+
+  static defaultProps = {
+    withAlpha: false
+  }
+
+  ref: HTMLDivElement | null = null
+
+  handleRef = (el: HTMLDivElement | null) => {
+    const { elementRef } = this.props
+
+    this.ref = el
+
+    if (typeof elementRef === 'function') {
+      elementRef(el)
+    }
+  }
+
+  componentDidMount() {
+    this.props.makeStyles?.()
+  }
+
+  componentDidUpdate(prevProps: RGBAInputProps) {
+    this.props.makeStyles?.()
+    if (
+      shallowCompare(prevProps.value, this.props.value) ||
+      shallowCompare(this.state.value, this.props.value)
+    ) {
+      this.setState({
+        value: this.props.value
+      })
+    }
+  }
+
+  handleChange(type: string, e: React.ChangeEvent<HTMLInputElement>) {
+    const upperLimit = type === 'a' ? 100 : 255
+    const newValue =
+      type === 'a' ? Number(e.target.value) / 100 : Number(e.target.value)
+    const newColor = { ...this.props.value, [type]: newValue }
+
+    if (!isNaN(Number(newValue)) && newValue >= 0 && newValue <= upperLimit) {
+      this.setState({ value: newColor })
+      this.props.onChange(newColor)
+      return
+    }
+  }
+
+  render() {
+    const { styles, disabled, label, withAlpha } = this.props
+    return (
+      <div ref={this.handleRef} css={styles?.RGBAInput}>
+        {label && <div css={styles?.label}>{label}</div>}
+        <div css={styles?.inputContainer}>
+          <span css={styles?.rgbInput}>
+            <TextInput
+              disabled={disabled}
+              value={`${this.state.value.r}`}
+              onChange={(e) => this.handleChange('r', e)}
+              renderLabel={
+                <ScreenReaderContent>
+                  {this.props.rgbRedInputScreenReaderLabel}
+                </ScreenReaderContent>
+              }
+            />
+          </span>
+          <span css={styles?.rgbInput}>
+            <TextInput
+              disabled={disabled}
+              value={`${this.state.value.g}`}
+              onChange={(e) => this.handleChange('g', e)}
+              renderLabel={
+                <ScreenReaderContent>
+                  {this.props.rgbGreenInputScreenReaderLabel}
+                </ScreenReaderContent>
+              }
+            />
+          </span>
+          <span css={styles?.rgbInput}>
+            <TextInput
+              disabled={disabled}
+              value={`${this.state.value.b}`}
+              onChange={(e) => this.handleChange('b', e)}
+              renderLabel={
+                <ScreenReaderContent>
+                  {this.props.rgbBlueInputScreenReaderLabel}
+                </ScreenReaderContent>
+              }
+            />
+          </span>
+          {withAlpha && (
+            <span css={styles?.aInput}>
+              <TextInput
+                aria-label="%"
+                disabled={disabled}
+                value={`${Math.round(this.state.value.a * 100)}`}
+                onChange={(e) => this.handleChange('a', e)}
+                renderAfterInput={
+                  <span aria-hidden="true" role="presentation">
+                    %
+                  </span>
+                }
+                renderLabel={
+                  <ScreenReaderContent>
+                    {this.props.rgbAlphaInputScreenReaderLabel}
+                  </ScreenReaderContent>
+                }
+              />
+            </span>
+          )}
+        </div>
+      </div>
+    )
+  }
+}
+
+export default RGBAInput

package/src/ColorMixer/RGBAInput/props.ts

@@ -0,0 +1,93 @@
+/*
+ * 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 PropTypes from 'prop-types'
+import type { WithStyleProps, ComponentStyle } from '@instructure/emotion'
+
+import type {
+  OtherHTMLAttributes,
+  PropValidators,
+  ColorMixerRGBAInputTheme
+} from '@instructure/shared-types'
+import type { RGBAType } from '../props'
+
+type RGBAInputOwnProps = {
+  disabled?: boolean
+  label?: string
+  width: number
+  value: RGBAType
+  onChange: (rgba: RGBAType) => void
+  withAlpha?: boolean
+  rgbRedInputScreenReaderLabel: string
+  rgbGreenInputScreenReaderLabel: string
+  rgbBlueInputScreenReaderLabel: string
+  rgbAlphaInputScreenReaderLabel: string
+  elementRef?: (element: Element | null) => void
+}
+
+type RGBAInputState = {
+  value: RGBAType
+}
+
+type PropKeys = keyof RGBAInputOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type RGBAInputProps = RGBAInputOwnProps &
+  WithStyleProps<ColorMixerRGBAInputTheme, RGBAInputStyle> &
+  OtherHTMLAttributes<RGBAInputOwnProps>
+
+type RGBAInputStyle = ComponentStyle<
+  'RGBAInput' | 'label' | 'inputContainer' | 'rgbInput' | 'aInput'
+>
+const propTypes: PropValidators<PropKeys> = {
+  disabled: PropTypes.bool,
+  label: PropTypes.string,
+  width: PropTypes.number.isRequired,
+  value: PropTypes.object.isRequired,
+  onChange: PropTypes.func.isRequired,
+  withAlpha: PropTypes.bool,
+  rgbRedInputScreenReaderLabel: PropTypes.string.isRequired,
+  rgbGreenInputScreenReaderLabel: PropTypes.string.isRequired,
+  rgbBlueInputScreenReaderLabel: PropTypes.string.isRequired,
+  rgbAlphaInputScreenReaderLabel: PropTypes.string.isRequired,
+  elementRef: PropTypes.func
+}
+
+const allowedProps: AllowedPropKeys = [
+  'disabled',
+  'label',
+  'width',
+  'value',
+  'onChange',
+  'withAlpha',
+  'rgbRedInputScreenReaderLabel',
+  'rgbGreenInputScreenReaderLabel',
+  'rgbBlueInputScreenReaderLabel',
+  'rgbAlphaInputScreenReaderLabel',
+  'elementRef'
+]
+
+export type { RGBAInputProps, RGBAInputState, RGBAInputStyle }
+export { propTypes, allowedProps }

package/src/ColorMixer/RGBAInput/styles.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 type { RGBAInputStyle, RGBAInputProps } from './props'
+import type { ColorMixerRGBAInputTheme } from '@instructure/shared-types'
+
+/**
+ * ---
+ * private: true
+ * ---
+ * Generates the style object from the theme and provided additional information
+ * @param  {Object} componentTheme The theme variable object.
+ * @param  {Object} props the props of the component, the style is applied to
+ * @param  {Object} state the state of the component, the style is applied to
+ * @return {Object} The final style object, which will be used in the component
+ */
+const generateStyle = (
+  componentTheme: ColorMixerRGBAInputTheme,
+  props: RGBAInputProps
+): RGBAInputStyle => {
+  return {
+    RGBAInput: {
+      label: 'RGBAInput',
+      marginTop: componentTheme.rgbaInputTopMargin,
+      width: `${props.width / 16}rem`
+    },
+    label: {
+      label: 'RGBAInput__label',
+      fontWeight: componentTheme.labelFontWeight
+    },
+    inputContainer: {
+      label: 'RGBAInput__inputContainer',
+      display: 'flex',
+      marginTop: componentTheme.inputContainerTopMargin
+    },
+    rgbInput: {
+      label: 'RGBAInput__rgbInput',
+      marginInlineEnd: componentTheme.tgbInputTopMargin,
+      flex: 7
+    },
+    aInput: {
+      label: 'RGBAInput__aInput',
+      flex: 10
+    }
+  }
+}
+
+export default generateStyle

package/src/ColorMixer/RGBAInput/theme.ts

@@ -0,0 +1,48 @@
+/*
+ * 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 type { Theme } from '@instructure/ui-themes'
+import { ColorMixerRGBAInputTheme } from '@instructure/shared-types'
+
+/**
+ * Generates the theme object for the component from the theme and provided additional information
+ * @param  {Object} theme The actual theme object.
+ * @return {Object} The final theme object with the overrides and component variables
+ */
+const generateComponentTheme = (theme: Theme): ColorMixerRGBAInputTheme => {
+  const { spacing, typography } = theme
+
+  const componentVariables = {
+    labelFontWeight: typography.fontWeightBold,
+    inputContainerTopMargin: spacing.xSmall,
+    tgbInputTopMargin: spacing.xSmall,
+    rgbaInputTopMargin: spacing.medium
+  }
+
+  return {
+    ...componentVariables
+  }
+}
+
+export default generateComponentTheme

package/src/ColorMixer/Slider/index.tsx

@@ -0,0 +1,242 @@
+/*
+ * 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.
+ */
+
+/** @jsx jsx */
+import React, { Component } from 'react'
+
+import { addEventListener } from '@instructure/ui-dom-utils'
+import { withStyle, jsx } from '@instructure/emotion'
+
+import { View } from '@instructure/ui-view'
+import type { ViewOwnProps } from '@instructure/ui-view'
+
+import { propTypes, allowedProps } from './props'
+import type { SliderProps, SliderStyleProps } from './props'
+
+import generateStyle from './styles'
+import generateComponentTheme from './theme'
+
+/**
+ * ---
+ * private: true
+ * ---
+ * @tsProps
+ **/
+@withStyle(generateStyle, generateComponentTheme)
+class Slider extends Component<SliderProps> {
+  static propTypes = propTypes
+  static allowedProps = allowedProps
+  static readonly componentId = 'ColorMixer.Slider'
+
+  static defaultProps = {
+    isColorSlider: false
+  }
+
+  ref: Element | null = null
+  private _sliderRef: HTMLDivElement | null = null
+  private _mouseMoveListener?: { remove(): void }
+  private _mouseUpListener?: { remove(): void }
+
+  handleRef = (el: Element | null) => {
+    const { elementRef } = this.props
+
+    this.ref = el
+
+    if (typeof elementRef === 'function') {
+      elementRef(el)
+    }
+  }
+
+  componentDidMount() {
+    this.props.makeStyles?.(this.makeStylesProps)
+  }
+
+  componentDidUpdate() {
+    this.props.makeStyles?.(this.makeStylesProps)
+  }
+
+  componentWillUnmount() {
+    this.removeEventListeners()
+  }
+
+  removeEventListeners() {
+    this._mouseMoveListener?.remove()
+    this._mouseUpListener?.remove()
+  }
+
+  get sliderPositionFromValue() {
+    return this.calcSliderPositionFromValue(this.props.value)
+  }
+
+  get roundedValue() {
+    const { value, maxValue } = this.props
+
+    if (maxValue <= 1) {
+      return Math.round(value * 100)
+    } else {
+      return Math.round(value)
+    }
+  }
+
+  get makeStylesProps(): SliderStyleProps {
+    return {
+      sliderPositionFromValue: this.sliderPositionFromValue
+    }
+  }
+
+  handleMouseDown(e: React.MouseEvent<ViewOwnProps, MouseEvent>) {
+    this.handleChange(e)
+
+    this._mouseMoveListener = addEventListener(
+      window,
+      'mousemove',
+      this.handleChange
+    )
+    this._mouseUpListener = addEventListener(
+      window,
+      'mouseup',
+      this.handleMouseUp
+    )
+  }
+
+  handleChange = (e: React.MouseEvent<ViewOwnProps, MouseEvent>) => {
+    if (this.props.disabled) return
+    const { clientX } = e
+    const newPosition = this.calcSliderPositionFromCursorPosition(
+      clientX,
+      this._sliderRef!
+    )
+
+    this.props.onChange(this.calcValueFromSliderPosition(newPosition))
+  }
+
+  handleMouseUp = () => {
+    this.removeEventListeners()
+  }
+
+  applyBoundaries(x: number) {
+    if (x > this.props.width) return this.props.width
+    if (x < 0) return 0
+    return x
+  }
+
+  calcSliderPositionFromCursorPosition = (
+    clientX: number,
+    _sliderRef: HTMLDivElement
+  ) => {
+    if (this.props.isColorSlider) {
+      const { x } = _sliderRef.getBoundingClientRect()
+      const newPosition = clientX - x
+      return newPosition < 0
+        ? 0
+        : newPosition > this.props.width
+        ? this.props.width - 1
+        : newPosition
+    } else {
+      const { x } = _sliderRef.getBoundingClientRect()
+      return clientX - x
+    }
+  }
+
+  calcSliderPositionFromValue = (value: number) => {
+    if (this.props.isColorSlider) {
+      return (value / 360) * this.props.width
+    } else {
+      return this.props.width - (1 - value) * this.props.width
+    }
+  }
+
+  calcValueFromSliderPosition = (position: number) => {
+    if (this.props.isColorSlider) {
+      return (position / this.props.width) * 360
+    } else {
+      const positionWithBoundaries =
+        position < 0
+          ? 0
+          : position > this.props.width
+          ? this.props.width
+          : position
+      return Math.round((positionWithBoundaries * 100) / this.props.width)
+    }
+  }
+
+  handleKeyDown(e: React.KeyboardEvent<ViewOwnProps>) {
+    const { key } = e
+    if (key === 'Tab') return
+    e.preventDefault()
+    let deltaX = 0
+    if (key === 'ArrowLeft' || key === 'a') {
+      deltaX = -2
+    }
+    if (key === 'ArrowRight' || key === 'd') {
+      deltaX = 2
+    }
+
+    const newPosition = this.applyBoundaries(
+      this.sliderPositionFromValue + deltaX
+    )
+    this.props.onChange(this.calcValueFromSliderPosition(newPosition))
+  }
+
+  render() {
+    return (
+      <View
+        elementRef={this.handleRef}
+        disabled={this.props.disabled}
+        position="relative"
+        background="transparent"
+        margin="small 0 0 0"
+        display="inline-block"
+        borderRadius="medium"
+        borderWidth="0"
+        padding="0"
+        as="div"
+        onKeyDown={(e) => this.handleKeyDown(e)}
+        onMouseDown={(e) => this.handleMouseDown(e)}
+        tabIndex={this.props.disabled ? undefined : 0}
+        aria-label={this.props.navigationExplanationScreenReaderLabel}
+        // TODO: check RangeInput and ProgressBar to see how the slider role can be handled well
+        // role="slider"
+        // aria-valuemin={this.props.minValue}
+        // aria-valuemax={this.props.maxValue}
+        // aria-valuenow={this.roundedValue}
+      >
+        <div css={this.props.styles?.indicator} />
+        {this.props.disabled && (
+          <div css={this.props.styles?.disabledOverlay} />
+        )}
+        <div
+          ref={(ref) => {
+            this._sliderRef = ref
+          }}
+          css={this.props.styles?.sliderBackground}
+        >
+          <div css={this.props.styles?.slider} />
+        </div>
+      </View>
+    )
+  }
+}
+
+export default Slider