@instructure/ui-themeable/src/ThemeContext.js

A UI component library made by Instructure Inc.

/*
 * 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.
 */

/**
 * ---
 * category: utilities/themes
 * ---
 * @module ThemeContext
 */
import PropTypes from 'prop-types'

const CONTEXT_KEY = '@@themeable'

const ThemeContext = {
  CONTEXT_KEY,

  /**
   * React context types for [themeable](#themeable) components and
   * the [ApplyTheme](#ApplyTheme) component.
   */
  types: {
    [CONTEXT_KEY]: PropTypes.object
  },

  /**
   * create theme context
   * @param {Object} theme an object containing [themeable](#themeable) component themes
   * @param {Boolean} immutable prevent theme overrides?
   */
  makeThemeContext(theme, immutable) {
    return {
      [CONTEXT_KEY]: {
        theme,
        immutable
      }
    }
  },

  /**
   * get a theme context
   * @param {ReactContext} context React context object
   */
  getThemeContext(context) {
    if (context) {
      return context[CONTEXT_KEY]
    }
  }
}

export default ThemeContext
export { ThemeContext }