@instructure/ui-i18n 8.11.2-snapshot.7 → 8.11.2-snapshot.70

package/es/ApplyTextDirection/index.js

@@ -29,10 +29,11 @@ import { DIRECTION, TextDirectionContext } from '../TextDirectionContext';
 ---
 category: components/utilities
 ---
+DEPRECATED. Please use TextDirectionContext instead.
 @tsProps
 **/
 const ApplyTextDirection = props => {
-  const context = useTextDirectionContext();
+  const context = useContext(TextDirectionContext);
   const dir = props.dir || context;
   const ElementType = getElementType(ApplyTextDirection, props);
   return /*#__PURE__*/React.createElement(TextDirectionContext.Provider, {
@@ -47,10 +48,4 @@ ApplyTextDirection.defaultProps = {
   as: 'span',
   children: null
 };
-ApplyTextDirection.DIRECTION = DIRECTION;
-
-const useTextDirectionContext = () => {
-  return useContext(TextDirectionContext);
-};
-
-export { ApplyTextDirection, useTextDirectionContext };
+export { ApplyTextDirection };

package/es/DateTime.js

@@ -27,7 +27,8 @@ import moment from 'moment-timezone';
  * category: utilities/i18n
  * ---
  * @deprecated
- * ##### DEPRECATION WARNING: Will be removed in v9 since it provides no further benefit over using dayjs
+ * #### DEPRECATION WARNING: Will be removed in v9, which wil include a
+ * time library agnostic API.
  * A wrapper for [moment](https://momentjs.com/) utils.
  * @module DateTime
  */
@@ -79,6 +80,38 @@ function isValid(dateString) {
 function browserTimeZone() {
   return moment.tz.guess();
 }
+/**
+ * Returns the days of the week in the given locale,
+ * for example ["Monday", "Tuesday",..]. It always begins with Monday.
+ * @param locale A locale accepted by the browser, e.g. America/New_York
+ * @param format If set to 'short' it will be maximum 3 letters long,
+ *               if set to 'long' it will be the full word.
+ */
+
+
+function getLocalDayNamesOfTheWeek(locale, format) {
+  const ret = [];
+  const toFormat = format === 'short' ? 'dd' : 'dddd';
+  let currentDay = getFirstDayOfWeek(now(locale, browserTimeZone()));
+
+  for (let i = 0; i < 7; i++) {
+    ret.push(currentDay.format(toFormat));
+    currentDay = currentDay.add(1, 'day'); // TODO this is mutable
+  }
+
+  return ret;
+}
+/**
+ * Returns the first day of the week in the given locale.
+ * The locale decides what is the first day, e.g. Sunday in the US, Monday in
+ * the EU.
+ * @param date A Moment Datetime object
+ */
+
+
+function getFirstDayOfWeek(date) {
+  return date.clone().weekday(0);
+}
 /**
  * Return a localized date + time with timezone as a ISO 8601 string
  * @param {String} dateString
@@ -105,7 +138,9 @@ const DateTime = {
   parse,
   browserTimeZone,
   isValid,
-  toLocaleString
+  toLocaleString,
+  getFirstDayOfWeek,
+  getLocalDayNamesOfTheWeek
 };
 export default DateTime;
 export { DateTime };

package/es/TextDirectionContext.js

@@ -23,10 +23,26 @@
  */
 import { createContext } from 'react';
 import { getTextDirection } from './getTextDirection';
+/**
+ * ---
+ * category: utilities/i18n
+ * ---
+ *
+ * This React context the text direction. I can have 2 values:
+ * `ltr`, `rtl`. Its default value is the document's `dir` value, if
+ * this is not given then `ltr`. For more info on the values see
+ * [mdn](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).
+ * If its set to `ltr` or `rtl` then some InstUI components (e.g.
+ * [DrawerLayout](#DrawerLayout) will automatically orient based on its value.
+ *
+ * @module TextDirectionContext
+ */
+
 const TextDirectionContext = /*#__PURE__*/createContext(getTextDirection() || 'ltr');
 const DIRECTION = {
   ltr: 'ltr',
-  rtl: 'rtl'
+  rtl: 'rtl' //TODO add auto: 'auto' in the future
+
 };
 export default TextDirectionContext;
 export { TextDirectionContext, DIRECTION };

package/es/bidirectional.js

@@ -36,6 +36,9 @@ import hoistNonReactStatics from 'hoist-non-react-statics'; // This is a workaro
  * ---
  * category: utilities/i18n
  * ---
+ *
+ * #### DEPRECATED: This has been renamed to `textDirectionContextConsumer`, its functionality remains similar.
+ *
  * A decorator or higher order component that makes a component `bidirectional`.
  *
  * As a HOC:
@@ -52,8 +55,8 @@ import hoistNonReactStatics from 'hoist-non-react-statics'; // This is a workaro
  * export default bidirectional()(Example)
  * ```
  *
- * When used as a child of [ApplyTextDirection](#ApplyTextDirection), bidirectional components use
- * the direction provided in the context. When used without [ApplyTextDirection](#ApplyTextDirection),
+ * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), bidirectional components use
+ * the direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),
  * the direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,
  * bidirectional components query the documentElement for the `dir` attribute, defaulting to `ltr`
  * if it is not present.
@@ -66,12 +69,21 @@ const bidirectional = decorator(ComposedComponent => {
     render() {
       const _this$props = this.props,
             forwardedRef = _this$props.forwardedRef,
-            rest = _objectWithoutProperties(_this$props, _excluded);
+            rest = _objectWithoutProperties(_this$props, _excluded); // Quite complex code, this is the priority order of applying the `dir` prop:
+      // 1. The highest priority is adding it via a prop
+      // 2. If there is a <TextDirectionContext.Provider> (or <ApplyTextDirection>
+      //    which uses it) above the @bidirectional in the DOM, use its value.
+      // 3. If TextDirectionContext.Provider was called without params
+      //    TextDirectionContext calls getTextDirection() which returns
+      //    the 'dir' prop of the HTML document element.
+
 
-      return /*#__PURE__*/React.createElement(TextDirectionContext.Consumer, null, dir => /*#__PURE__*/React.createElement(ComposedComponent, Object.assign({
-        ref: forwardedRef,
-        dir: dir
-      }, rest)));
+      return /*#__PURE__*/React.createElement(TextDirectionContext.Consumer, null, dir => {
+        return /*#__PURE__*/React.createElement(ComposedComponent, Object.assign({
+          ref: forwardedRef,
+          dir: dir
+        }, rest));
+      });
     }
 
   }

package/es/getTextDirection.js

@@ -65,10 +65,11 @@ const getDefaultDir = () => {
  * category: utilities/i18n
  * ---
  *
- * Return the direction ('ltr' or 'rtl') of an element
+ * Return the direction ('ltr' or 'rtl' or 'auto') of an element. If no element
+ * is given, it returns the document's 'dir' value.
  * @module getTextDirection
  * @param {Element} element will use the <html> element by default
- * @returns {String} 'ltr' or 'rtl' (or `undefined` if no DOM is present)
+ * @returns {String} 'ltr' or 'rtl' or 'auto' (or `undefined` if no DOM is present)
  */
 
 

package/es/index.js

@@ -24,9 +24,10 @@
 export { ApplyLocale } from './ApplyLocale';
 export { ApplyLocaleContext } from './ApplyLocale/ApplyLocaleContext';
 export { bidirectional } from './bidirectional';
+export { textDirectionContextConsumer } from './textDirectionContextConsumer';
 export { DateTime } from './DateTime';
 export { getTextDirection } from './getTextDirection';
 export { I18nPropTypes } from './I18nPropTypes';
 export { Locale } from './Locale';
 export { DIRECTION, TextDirectionContext } from './TextDirectionContext';
-export { useTextDirectionContext, ApplyTextDirection } from './ApplyTextDirection';
+export { ApplyTextDirection } from './ApplyTextDirection';

package/es/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/es/textDirectionContextConsumer.js

@@ -0,0 +1,59 @@
+/*
+ * 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 { bidirectional } from './bidirectional';
+/**
+ * ---
+ * category: utilities/i18n
+ * ---
+ *
+ * A decorator or higher order component that supplies the text direction to
+ * components.
+ *
+ * As a HOC:
+ *
+ * ```js
+ * import { textDirectionContextConsumer } from '@instructure/ui-i18n'
+ *
+ * class Example extends React.Component {
+ *   render () {
+ *     return this.props.dir === textDirectionContextConsumer.DIRECTION.rtl ? <div>rtl</div> : <div>ltr</div>
+ *   }
+ * }
+ *
+ * export default textDirectionContextConsumer()(Example)
+ * ```
+ *
+ * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), bidirectional components use
+ * the direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),
+ * the direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,
+ * bidirectional components query the documentElement for the `dir` attribute, defaulting to `ltr`
+ * if it is not present.
+ *
+ * @module textDirectionContextConsumer
+ * @return The decorator that composes the bidirectional component.
+ */
+
+const textDirectionContextConsumer = bidirectional;
+export default textDirectionContextConsumer;
+export { textDirectionContextConsumer };

package/lib/ApplyTextDirection/index.js

@@ -5,7 +5,7 @@ var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWild
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useTextDirectionContext = exports.ApplyTextDirection = void 0;
+exports.ApplyTextDirection = void 0;
 
 var _react = _interopRequireWildcard(require("react"));
 
@@ -41,10 +41,11 @@ var _TextDirectionContext = require("../TextDirectionContext");
 ---
 category: components/utilities
 ---
+DEPRECATED. Please use TextDirectionContext instead.
 @tsProps
 **/
 const ApplyTextDirection = props => {
-  const context = useTextDirectionContext();
+  const context = (0, _react.useContext)(_TextDirectionContext.TextDirectionContext);
   const dir = props.dir || context;
   const ElementType = (0, _getElementType.getElementType)(ApplyTextDirection, props);
   return /*#__PURE__*/_react.default.createElement(_TextDirectionContext.TextDirectionContext.Provider, {
@@ -59,11 +60,4 @@ ApplyTextDirection.defaultProps = {
   dir: void 0,
   as: 'span',
   children: null
-};
-ApplyTextDirection.DIRECTION = _TextDirectionContext.DIRECTION;
-
-const useTextDirectionContext = () => {
-  return (0, _react.useContext)(_TextDirectionContext.TextDirectionContext);
-};
-
-exports.useTextDirectionContext = useTextDirectionContext;
+};

package/lib/DateTime.js

@@ -38,7 +38,8 @@ var _momentTimezone = _interopRequireDefault(require("moment-timezone"));
  * category: utilities/i18n
  * ---
  * @deprecated
- * ##### DEPRECATION WARNING: Will be removed in v9 since it provides no further benefit over using dayjs
+ * #### DEPRECATION WARNING: Will be removed in v9, which wil include a
+ * time library agnostic API.
  * A wrapper for [moment](https://momentjs.com/) utils.
  * @module DateTime
  */
@@ -89,6 +90,38 @@ function isValid(dateString) {
 function browserTimeZone() {
   return _momentTimezone.default.tz.guess();
 }
+/**
+ * Returns the days of the week in the given locale,
+ * for example ["Monday", "Tuesday",..]. It always begins with Monday.
+ * @param locale A locale accepted by the browser, e.g. America/New_York
+ * @param format If set to 'short' it will be maximum 3 letters long,
+ *               if set to 'long' it will be the full word.
+ */
+
+
+function getLocalDayNamesOfTheWeek(locale, format) {
+  const ret = [];
+  const toFormat = format === 'short' ? 'dd' : 'dddd';
+  let currentDay = getFirstDayOfWeek(now(locale, browserTimeZone()));
+
+  for (let i = 0; i < 7; i++) {
+    ret.push(currentDay.format(toFormat));
+    currentDay = currentDay.add(1, 'day'); // TODO this is mutable
+  }
+
+  return ret;
+}
+/**
+ * Returns the first day of the week in the given locale.
+ * The locale decides what is the first day, e.g. Sunday in the US, Monday in
+ * the EU.
+ * @param date A Moment Datetime object
+ */
+
+
+function getFirstDayOfWeek(date) {
+  return date.clone().weekday(0);
+}
 /**
  * Return a localized date + time with timezone as a ISO 8601 string
  * @param {String} dateString
@@ -115,7 +148,9 @@ const DateTime = {
   parse,
   browserTimeZone,
   isValid,
-  toLocaleString
+  toLocaleString,
+  getFirstDayOfWeek,
+  getLocalDayNamesOfTheWeek
 };
 exports.DateTime = DateTime;
 var _default = DateTime;

package/lib/TextDirectionContext.js

@@ -32,11 +32,27 @@ var _getTextDirection = require("./getTextDirection");
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
+/**
+ * ---
+ * category: utilities/i18n
+ * ---
+ *
+ * This React context the text direction. I can have 2 values:
+ * `ltr`, `rtl`. Its default value is the document's `dir` value, if
+ * this is not given then `ltr`. For more info on the values see
+ * [mdn](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).
+ * If its set to `ltr` or `rtl` then some InstUI components (e.g.
+ * [DrawerLayout](#DrawerLayout) will automatically orient based on its value.
+ *
+ * @module TextDirectionContext
+ */
 const TextDirectionContext = /*#__PURE__*/(0, _react.createContext)((0, _getTextDirection.getTextDirection)() || 'ltr');
 exports.TextDirectionContext = TextDirectionContext;
 const DIRECTION = {
   ltr: 'ltr',
-  rtl: 'rtl'
+  rtl: 'rtl' //TODO add auto: 'auto' in the future
+
 };
 exports.DIRECTION = DIRECTION;
 var _default = TextDirectionContext;

package/lib/bidirectional.js

@@ -25,6 +25,9 @@ const _excluded = ["forwardedRef"];
  * ---
  * category: utilities/i18n
  * ---
+ *
+ * #### DEPRECATED: This has been renamed to `textDirectionContextConsumer`, its functionality remains similar.
+ *
  * A decorator or higher order component that makes a component `bidirectional`.
  *
  * As a HOC:
@@ -41,8 +44,8 @@ const _excluded = ["forwardedRef"];
  * export default bidirectional()(Example)
  * ```
  *
- * When used as a child of [ApplyTextDirection](#ApplyTextDirection), bidirectional components use
- * the direction provided in the context. When used without [ApplyTextDirection](#ApplyTextDirection),
+ * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), bidirectional components use
+ * the direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),
  * the direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,
  * bidirectional components query the documentElement for the `dir` attribute, defaulting to `ltr`
  * if it is not present.
@@ -55,11 +58,20 @@ const bidirectional = (0, _decorator.decorator)(ComposedComponent => {
     render() {
       const _this$props = this.props,
             forwardedRef = _this$props.forwardedRef,
-            rest = (0, _objectWithoutProperties2.default)(_this$props, _excluded);
-      return /*#__PURE__*/_react.default.createElement(_TextDirectionContext.TextDirectionContext.Consumer, null, dir => /*#__PURE__*/_react.default.createElement(ComposedComponent, Object.assign({
-        ref: forwardedRef,
-        dir: dir
-      }, rest)));
+            rest = (0, _objectWithoutProperties2.default)(_this$props, _excluded); // Quite complex code, this is the priority order of applying the `dir` prop:
+      // 1. The highest priority is adding it via a prop
+      // 2. If there is a <TextDirectionContext.Provider> (or <ApplyTextDirection>
+      //    which uses it) above the @bidirectional in the DOM, use its value.
+      // 3. If TextDirectionContext.Provider was called without params
+      //    TextDirectionContext calls getTextDirection() which returns
+      //    the 'dir' prop of the HTML document element.
+
+      return /*#__PURE__*/_react.default.createElement(_TextDirectionContext.TextDirectionContext.Consumer, null, dir => {
+        return /*#__PURE__*/_react.default.createElement(ComposedComponent, Object.assign({
+          ref: forwardedRef,
+          dir: dir
+        }, rest));
+      });
     }
 
   }

package/lib/getTextDirection.js

@@ -76,10 +76,11 @@ const getDefaultDir = () => {
  * category: utilities/i18n
  * ---
  *
- * Return the direction ('ltr' or 'rtl') of an element
+ * Return the direction ('ltr' or 'rtl' or 'auto') of an element. If no element
+ * is given, it returns the document's 'dir' value.
  * @module getTextDirection
  * @param {Element} element will use the <html> element by default
- * @returns {String} 'ltr' or 'rtl' (or `undefined` if no DOM is present)
+ * @returns {String} 'ltr' or 'rtl' or 'auto' (or `undefined` if no DOM is present)
  */
 
 

package/lib/index.js

@@ -21,6 +21,12 @@ Object.defineProperty(exports, "bidirectional", {
     return _bidirectional.bidirectional;
   }
 });
+Object.defineProperty(exports, "textDirectionContextConsumer", {
+  enumerable: true,
+  get: function () {
+    return _textDirectionContextConsumer.textDirectionContextConsumer;
+  }
+});
 Object.defineProperty(exports, "DateTime", {
   enumerable: true,
   get: function () {
@@ -57,12 +63,6 @@ Object.defineProperty(exports, "TextDirectionContext", {
     return _TextDirectionContext.TextDirectionContext;
   }
 });
-Object.defineProperty(exports, "useTextDirectionContext", {
-  enumerable: true,
-  get: function () {
-    return _ApplyTextDirection.useTextDirectionContext;
-  }
-});
 Object.defineProperty(exports, "ApplyTextDirection", {
   enumerable: true,
   get: function () {
@@ -76,6 +76,8 @@ var _ApplyLocaleContext = require("./ApplyLocale/ApplyLocaleContext");
 
 var _bidirectional = require("./bidirectional");
 
+var _textDirectionContextConsumer = require("./textDirectionContextConsumer");
+
 var _DateTime = require("./DateTime");
 
 var _getTextDirection = require("./getTextDirection");

package/lib/textDirectionContextConsumer.js

@@ -0,0 +1,68 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.textDirectionContextConsumer = exports.default = void 0;
+
+var _bidirectional = require("./bidirectional");
+
+/*
+ * 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/i18n
+ * ---
+ *
+ * A decorator or higher order component that supplies the text direction to
+ * components.
+ *
+ * As a HOC:
+ *
+ * ```js
+ * import { textDirectionContextConsumer } from '@instructure/ui-i18n'
+ *
+ * class Example extends React.Component {
+ *   render () {
+ *     return this.props.dir === textDirectionContextConsumer.DIRECTION.rtl ? <div>rtl</div> : <div>ltr</div>
+ *   }
+ * }
+ *
+ * export default textDirectionContextConsumer()(Example)
+ * ```
+ *
+ * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), bidirectional components use
+ * the direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),
+ * the direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,
+ * bidirectional components query the documentElement for the `dir` attribute, defaulting to `ltr`
+ * if it is not present.
+ *
+ * @module textDirectionContextConsumer
+ * @return The decorator that composes the bidirectional component.
+ */
+const textDirectionContextConsumer = _bidirectional.bidirectional;
+exports.textDirectionContextConsumer = textDirectionContextConsumer;
+var _default = textDirectionContextConsumer;
+exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-i18n",
-  "version": "8.11.2-snapshot.7+2681e145a",
+  "version": "8.11.2-snapshot.70+9653a896e",
   "description": "Helper components and utilities for internationalization.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -24,18 +24,18 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-test-utils": "8.11.2-snapshot.7+2681e145a",
+    "@instructure/ui-babel-preset": "8.11.2-snapshot.70+9653a896e",
+    "@instructure/ui-test-utils": "8.11.2-snapshot.70+9653a896e",
     "@types/hoist-non-react-statics": "^3.3.1"
   },
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/shared-types": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-decorator": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-dom-utils": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-prop-types": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-react-utils": "8.11.2-snapshot.7+2681e145a",
-    "@instructure/ui-utils": "8.11.2-snapshot.7+2681e145a",
+    "@instructure/shared-types": "8.11.2-snapshot.70+9653a896e",
+    "@instructure/ui-decorator": "8.11.2-snapshot.70+9653a896e",
+    "@instructure/ui-dom-utils": "8.11.2-snapshot.70+9653a896e",
+    "@instructure/ui-prop-types": "8.11.2-snapshot.70+9653a896e",
+    "@instructure/ui-react-utils": "8.11.2-snapshot.70+9653a896e",
+    "@instructure/ui-utils": "8.11.2-snapshot.70+9653a896e",
     "hoist-non-react-statics": "^3.3.2",
     "moment-timezone": "^0.5",
     "prop-types": "^15"
@@ -47,5 +47,5 @@
     "access": "public"
   },
   "sideEffects": false,
-  "gitHead": "2681e145ad469e1396536d3e9eed75a19995eb8a"
+  "gitHead": "9653a896e80ba4d73335225e80807746a232d96d"
 }

package/src/ApplyTextDirection/README.md

@@ -2,6 +2,10 @@
 describes: ApplyTextDirection
 ---
 
+#### DEPRECATED
+
+Please use [TextDirectionContext](#TextDirectionContext) instead.
+
 A utility component used to manage text direction. In addition to appending the `dir` attribute to
 its underlying DOM node, `<ApplyTextDirection />` also creates a direction context which can be
 consumed by child components that have implemented [bidirectional](#bidirectional).

package/src/ApplyTextDirection/index.tsx

@@ -32,13 +32,13 @@ import { ApplyTextDirectionProps } from './props'
 ---
 category: components/utilities
 ---
+DEPRECATED. Please use TextDirectionContext instead.
 @tsProps
 **/
 const ApplyTextDirection = (props: ApplyTextDirectionProps) => {
-  const context = useTextDirectionContext()
+  const context = useContext(TextDirectionContext)
   const dir = props.dir || context
   const ElementType = getElementType(ApplyTextDirection, props)
-
   return (
     <TextDirectionContext.Provider value={dir}>
       {
@@ -58,10 +58,4 @@ ApplyTextDirection.defaultProps = {
   children: null
 } as const
 
-ApplyTextDirection.DIRECTION = DIRECTION
-
-const useTextDirectionContext = () => {
-  return useContext(TextDirectionContext)
-}
-
-export { ApplyTextDirection, useTextDirectionContext }
+export { ApplyTextDirection }

package/src/ApplyTextDirection/props.ts

@@ -25,8 +25,21 @@
 import React from 'react'
 import { AsElementType } from '@instructure/shared-types'
 
+type DirValues = 'ltr' | 'rtl' | 'auto'
+
 export type ApplyTextDirectionProps = {
-  dir?: 'ltr' | 'rtl'
-  children?: React.ReactNode | ((...args: any[]) => React.ReactNode)
+  /**
+   * The direction value to use. For values and their effects see
+   * https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir
+   */
+  dir?: DirValues
+  /**
+   * The children of this component. Either a React node or a function
+   * that receives 2 parameters (text direction, is rtl direction?) and
+   * returns a React node
+   */
+  children?:
+    | React.ReactNode
+    | ((dir: DirValues, isRtl: boolean) => React.ReactNode)
   as?: AsElementType
 }

package/src/DateTime.ts

@@ -22,14 +22,15 @@
  * SOFTWARE.
  */
 
-import moment from 'moment-timezone'
+import moment, { Moment } from 'moment-timezone'
 
 /**
  * ---
  * category: utilities/i18n
  * ---
  * @deprecated
- * ##### DEPRECATION WARNING: Will be removed in v9 since it provides no further benefit over using dayjs
+ * #### DEPRECATION WARNING: Will be removed in v9, which wil include a
+ * time library agnostic API.
  * A wrapper for [moment](https://momentjs.com/) utils.
  * @module DateTime
  */
@@ -81,6 +82,34 @@ function browserTimeZone() {
   return moment.tz.guess()
 }
 
+/**
+ * Returns the days of the week in the given locale,
+ * for example ["Monday", "Tuesday",..]. It always begins with Monday.
+ * @param locale A locale accepted by the browser, e.g. America/New_York
+ * @param format If set to 'short' it will be maximum 3 letters long,
+ *               if set to 'long' it will be the full word.
+ */
+function getLocalDayNamesOfTheWeek(locale: string, format: 'short' | 'long') {
+  const ret: string[] = []
+  const toFormat = format === 'short' ? 'dd' : 'dddd'
+  let currentDay = getFirstDayOfWeek(now(locale, browserTimeZone()))
+  for (let i = 0; i < 7; i++) {
+    ret.push(currentDay.format(toFormat))
+    currentDay = currentDay.add(1, 'day') // TODO this is mutable
+  }
+  return ret
+}
+
+/**
+ * Returns the first day of the week in the given locale.
+ * The locale decides what is the first day, e.g. Sunday in the US, Monday in
+ * the EU.
+ * @param date A Moment Datetime object
+ */
+function getFirstDayOfWeek(date: Moment) {
+  return date.clone().weekday(0)
+}
+
 /**
  * Return a localized date + time with timezone as a ISO 8601 string
  * @param {String} dateString
@@ -110,8 +139,11 @@ const DateTime = {
   parse,
   browserTimeZone,
   isValid,
-  toLocaleString
+  toLocaleString,
+  getFirstDayOfWeek,
+  getLocalDayNamesOfTheWeek
 }
 
 export default DateTime
 export { DateTime }
+export type { Moment }

package/src/TextDirectionContext.ts

@@ -25,11 +25,26 @@
 import { createContext } from 'react'
 import { getTextDirection } from './getTextDirection'
 
+/**
+ * ---
+ * category: utilities/i18n
+ * ---
+ *
+ * This React context the text direction. I can have 2 values:
+ * `ltr`, `rtl`. Its default value is the document's `dir` value, if
+ * this is not given then `ltr`. For more info on the values see
+ * [mdn](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).
+ * If its set to `ltr` or `rtl` then some InstUI components (e.g.
+ * [DrawerLayout](#DrawerLayout) will automatically orient based on its value.
+ *
+ * @module TextDirectionContext
+ */
 const TextDirectionContext = createContext(getTextDirection() || 'ltr')
 
 const DIRECTION = {
   ltr: 'ltr',
   rtl: 'rtl'
+  //TODO add auto: 'auto' in the future
 }
 
 export default TextDirectionContext

package/src/bidirectional.tsx

@@ -31,7 +31,7 @@ import hoistNonReactStatics from 'hoist-non-react-statics'
 // that uses the bidirectional decorator.
 // see https://github.com/microsoft/TypeScript/issues/4881
 export type BidirectionalProps = {
-  dir?: 'ltr' | 'rtl'
+  dir?: 'ltr' | 'rtl' // TODO add | 'auto' in the future
 }
 
 type BidirectionalInternalProps = {
@@ -47,6 +47,9 @@ type BidirectionalType = {
  * ---
  * category: utilities/i18n
  * ---
+ *
+ * #### DEPRECATED: This has been renamed to `textDirectionContextConsumer`, its functionality remains similar.
+ *
  * A decorator or higher order component that makes a component `bidirectional`.
  *
  * As a HOC:
@@ -63,8 +66,8 @@ type BidirectionalType = {
  * export default bidirectional()(Example)
  * ```
  *
- * When used as a child of [ApplyTextDirection](#ApplyTextDirection), bidirectional components use
- * the direction provided in the context. When used without [ApplyTextDirection](#ApplyTextDirection),
+ * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), bidirectional components use
+ * the direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),
  * the direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,
  * bidirectional components query the documentElement for the `dir` attribute, defaulting to `ltr`
  * if it is not present.
@@ -76,11 +79,18 @@ const bidirectional: BidirectionalType = decorator((ComposedComponent) => {
   class BidirectionalComponent extends React.Component<BidirectionalInternalProps> {
     render() {
       const { forwardedRef, ...rest } = this.props
+      // Quite complex code, this is the priority order of applying the `dir` prop:
+      // 1. The highest priority is adding it via a prop
+      // 2. If there is a <TextDirectionContext.Provider> (or <ApplyTextDirection>
+      //    which uses it) above the @bidirectional in the DOM, use its value.
+      // 3. If TextDirectionContext.Provider was called without params
+      //    TextDirectionContext calls getTextDirection() which returns
+      //    the 'dir' prop of the HTML document element.
       return (
         <TextDirectionContext.Consumer>
-          {(dir) => (
-            <ComposedComponent ref={forwardedRef} dir={dir} {...rest} />
-          )}
+          {(dir) => {
+            return <ComposedComponent ref={forwardedRef} dir={dir} {...rest} />
+          }}
         </TextDirectionContext.Consumer>
       )
     }
@@ -103,5 +113,6 @@ const bidirectional: BidirectionalType = decorator((ComposedComponent) => {
 }) as BidirectionalType
 
 bidirectional.DIRECTION = DIRECTION
+
 export default bidirectional
 export { bidirectional }

package/src/getTextDirection.ts

@@ -64,10 +64,11 @@ const getDefaultDir = () => {
  * category: utilities/i18n
  * ---
  *
- * Return the direction ('ltr' or 'rtl') of an element
+ * Return the direction ('ltr' or 'rtl' or 'auto') of an element. If no element
+ * is given, it returns the document's 'dir' value.
  * @module getTextDirection
  * @param {Element} element will use the <html> element by default
- * @returns {String} 'ltr' or 'rtl' (or `undefined` if no DOM is present)
+ * @returns {String} 'ltr' or 'rtl' or 'auto' (or `undefined` if no DOM is present)
  */
 function getTextDirection(element?: Element) {
   if (canUseDOM) {

package/src/index.ts

@@ -26,16 +26,15 @@ export { ApplyLocale } from './ApplyLocale'
 export { ApplyLocaleContext } from './ApplyLocale/ApplyLocaleContext'
 
 export { bidirectional } from './bidirectional'
+export { textDirectionContextConsumer } from './textDirectionContextConsumer'
 export { DateTime } from './DateTime'
 export { getTextDirection } from './getTextDirection'
 export { I18nPropTypes } from './I18nPropTypes'
 export { Locale } from './Locale'
 export { DIRECTION, TextDirectionContext } from './TextDirectionContext'
-export {
-  useTextDirectionContext,
-  ApplyTextDirection
-} from './ApplyTextDirection'
+export { ApplyTextDirection } from './ApplyTextDirection'
 
+export type { Moment } from './DateTime'
 export type { BidirectionalProps } from './bidirectional'
 export type { ApplyLocaleProps } from './ApplyLocale/props'
 export type { ApplyTextDirectionProps } from './ApplyTextDirection/props'

package/src/textDirectionContextConsumer.tsx

@@ -0,0 +1,61 @@
+/*
+ * 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 { bidirectional } from './bidirectional'
+
+/**
+ * ---
+ * category: utilities/i18n
+ * ---
+ *
+ * A decorator or higher order component that supplies the text direction to
+ * components.
+ *
+ * As a HOC:
+ *
+ * ```js
+ * import { textDirectionContextConsumer } from '@instructure/ui-i18n'
+ *
+ * class Example extends React.Component {
+ *   render () {
+ *     return this.props.dir === textDirectionContextConsumer.DIRECTION.rtl ? <div>rtl</div> : <div>ltr</div>
+ *   }
+ * }
+ *
+ * export default textDirectionContextConsumer()(Example)
+ * ```
+ *
+ * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), bidirectional components use
+ * the direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),
+ * the direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,
+ * bidirectional components query the documentElement for the `dir` attribute, defaulting to `ltr`
+ * if it is not present.
+ *
+ * @module textDirectionContextConsumer
+ * @return The decorator that composes the bidirectional component.
+ */
+const textDirectionContextConsumer = bidirectional
+
+export default textDirectionContextConsumer
+export { textDirectionContextConsumer }

package/types/ApplyTextDirection/index.d.ts

@@ -4,6 +4,7 @@ import { ApplyTextDirectionProps } from './props';
 ---
 category: components/utilities
 ---
+DEPRECATED. Please use TextDirectionContext instead.
 @tsProps
 **/
 declare const ApplyTextDirection: {
@@ -13,11 +14,6 @@ declare const ApplyTextDirection: {
         readonly as: "span";
         readonly children: null;
     };
-    DIRECTION: {
-        ltr: string;
-        rtl: string;
-    };
 };
-declare const useTextDirectionContext: () => "ltr" | "rtl" | "auto";
-export { ApplyTextDirection, useTextDirectionContext };
+export { ApplyTextDirection };
 //# sourceMappingURL=index.d.ts.map

package/types/ApplyTextDirection/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ApplyTextDirection/index.tsx"],"names":[],"mappings":";AA4BA,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAA;AAEjD;;;;;GAKG;AACH,QAAA,MAAM,kBAAkB;YAAW,uBAAuB;;;;;;;;;;CAgBzD,CAAA;AAUD,QAAA,MAAM,uBAAuB,8BAE5B,CAAA;AAED,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ApplyTextDirection/index.tsx"],"names":[],"mappings":";AA4BA,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAA;AAEjD;;;;;;GAMG;AACH,QAAA,MAAM,kBAAkB;YAAW,uBAAuB;;;;;;CAezD,CAAA;AAQD,OAAO,EAAE,kBAAkB,EAAE,CAAA"}

package/types/ApplyTextDirection/props.d.ts

@@ -1,8 +1,19 @@
 import React from 'react';
 import { AsElementType } from '@instructure/shared-types';
+declare type DirValues = 'ltr' | 'rtl' | 'auto';
 export declare type ApplyTextDirectionProps = {
-    dir?: 'ltr' | 'rtl';
-    children?: React.ReactNode | ((...args: any[]) => React.ReactNode);
+    /**
+     * The direction value to use. For values and their effects see
+     * https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir
+     */
+    dir?: DirValues;
+    /**
+     * The children of this component. Either a React node or a function
+     * that receives 2 parameters (text direction, is rtl direction?) and
+     * returns a React node
+     */
+    children?: React.ReactNode | ((dir: DirValues, isRtl: boolean) => React.ReactNode);
     as?: AsElementType;
 };
+export {};
 //# sourceMappingURL=props.d.ts.map

package/types/ApplyTextDirection/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/ApplyTextDirection/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAEzD,oBAAY,uBAAuB,GAAG;IACpC,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACnB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAK,CAAC,SAAS,CAAC,CAAA;IAClE,EAAE,CAAC,EAAE,aAAa,CAAA;CACnB,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/ApplyTextDirection/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAEzD,aAAK,SAAS,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAA;AAEvC,oBAAY,uBAAuB,GAAG;IACpC;;;OAGG;IACH,GAAG,CAAC,EAAE,SAAS,CAAA;IACf;;;;OAIG;IACH,QAAQ,CAAC,EACL,KAAK,CAAC,SAAS,GACf,CAAC,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,KAAK,KAAK,CAAC,SAAS,CAAC,CAAA;IACzD,EAAE,CAAC,EAAE,aAAa,CAAA;CACnB,CAAA"}

package/types/DateTime.d.ts

@@ -1,10 +1,11 @@
-import moment from 'moment-timezone';
+import moment, { Moment } from 'moment-timezone';
 /**
  * ---
  * category: utilities/i18n
  * ---
  * @deprecated
- * ##### DEPRECATION WARNING: Will be removed in v9 since it provides no further benefit over using dayjs
+ * #### DEPRECATION WARNING: Will be removed in v9, which wil include a
+ * time library agnostic API.
  * A wrapper for [moment](https://momentjs.com/) utils.
  * @module DateTime
  */
@@ -35,6 +36,21 @@ declare function isValid(dateString: string): boolean;
  * @returns {String} a time zone identifier (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
  */
 declare function browserTimeZone(): string;
+/**
+ * Returns the days of the week in the given locale,
+ * for example ["Monday", "Tuesday",..]. It always begins with Monday.
+ * @param locale A locale accepted by the browser, e.g. America/New_York
+ * @param format If set to 'short' it will be maximum 3 letters long,
+ *               if set to 'long' it will be the full word.
+ */
+declare function getLocalDayNamesOfTheWeek(locale: string, format: 'short' | 'long'): string[];
+/**
+ * Returns the first day of the week in the given locale.
+ * The locale decides what is the first day, e.g. Sunday in the US, Monday in
+ * the EU.
+ * @param date A Moment Datetime object
+ */
+declare function getFirstDayOfWeek(date: Moment): moment.Moment;
 /**
  * Return a localized date + time with timezone as a ISO 8601 string
  * @param {String} dateString
@@ -50,7 +66,10 @@ declare const DateTime: {
     browserTimeZone: typeof browserTimeZone;
     isValid: typeof isValid;
     toLocaleString: typeof toLocaleString;
+    getFirstDayOfWeek: typeof getFirstDayOfWeek;
+    getLocalDayNamesOfTheWeek: typeof getLocalDayNamesOfTheWeek;
 };
 export default DateTime;
 export { DateTime };
+export type { Moment };
 //# sourceMappingURL=DateTime.d.ts.map

package/types/DateTime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DateTime.d.ts","sourceRoot":"","sources":["../src/DateTime.ts"],"names":[],"mappings":"AAwBA,OAAO,MAAM,MAAM,iBAAiB,CAAA;AAEpC;;;;;;;;GAQG;AAEH;;;;;GAKG;AACH,iBAAS,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,iBAG5C;AAED;;;;;;GAMG;AACH,iBAAS,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,iBASlE;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,UAAU,EAAE,MAAM,WAElC;AAED;;;;GAIG;AACH,iBAAS,eAAe,WAEvB;AAED;;;;;;;GAOG;AACH,iBAAS,cAAc,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,MAAM,UAKhB;AAOD,QAAA,MAAM,QAAQ;;;;;;CAMb,CAAA;AAED,eAAe,QAAQ,CAAA;AACvB,OAAO,EAAE,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"DateTime.d.ts","sourceRoot":"","sources":["../src/DateTime.ts"],"names":[],"mappings":"AAwBA,OAAO,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAEhD;;;;;;;;;GASG;AAEH;;;;;GAKG;AACH,iBAAS,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,iBAG5C;AAED;;;;;;GAMG;AACH,iBAAS,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,iBASlE;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,UAAU,EAAE,MAAM,WAElC;AAED;;;;GAIG;AACH,iBAAS,eAAe,WAEvB;AAED;;;;;;GAMG;AACH,iBAAS,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,YAS1E;AAED;;;;;GAKG;AACH,iBAAS,iBAAiB,CAAC,IAAI,EAAE,MAAM,iBAEtC;AAED;;;;;;;GAOG;AACH,iBAAS,cAAc,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,MAAM,UAKhB;AAOD,QAAA,MAAM,QAAQ;;;;;;;;CAQb,CAAA;AAED,eAAe,QAAQ,CAAA;AACvB,OAAO,EAAE,QAAQ,EAAE,CAAA;AACnB,YAAY,EAAE,MAAM,EAAE,CAAA"}

package/types/TextDirectionContext.d.ts

@@ -1,4 +1,18 @@
 /// <reference types="react" />
+/**
+ * ---
+ * category: utilities/i18n
+ * ---
+ *
+ * This React context the text direction. I can have 2 values:
+ * `ltr`, `rtl`. Its default value is the document's `dir` value, if
+ * this is not given then `ltr`. For more info on the values see
+ * [mdn](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).
+ * If its set to `ltr` or `rtl` then some InstUI components (e.g.
+ * [DrawerLayout](#DrawerLayout) will automatically orient based on its value.
+ *
+ * @module TextDirectionContext
+ */
 declare const TextDirectionContext: import("react").Context<"ltr" | "rtl" | "auto">;
 declare const DIRECTION: {
     ltr: string;

package/types/TextDirectionContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextDirectionContext.d.ts","sourceRoot":"","sources":["../src/TextDirectionContext.ts"],"names":[],"mappings":";AA2BA,QAAA,MAAM,oBAAoB,iDAA6C,CAAA;AAEvE,QAAA,MAAM,SAAS;;;CAGd,CAAA;AAED,eAAe,oBAAoB,CAAA;AACnC,OAAO,EAAE,oBAAoB,EAAE,SAAS,EAAE,CAAA"}
+{"version":3,"file":"TextDirectionContext.d.ts","sourceRoot":"","sources":["../src/TextDirectionContext.ts"],"names":[],"mappings":";AA2BA;;;;;;;;;;;;;GAaG;AACH,QAAA,MAAM,oBAAoB,iDAA6C,CAAA;AAEvE,QAAA,MAAM,SAAS;;;CAId,CAAA;AAED,eAAe,oBAAoB,CAAA;AACnC,OAAO,EAAE,oBAAoB,EAAE,SAAS,EAAE,CAAA"}

package/types/bidirectional.d.ts

@@ -10,6 +10,9 @@ declare type BidirectionalType = {
  * ---
  * category: utilities/i18n
  * ---
+ *
+ * #### DEPRECATED: This has been renamed to `textDirectionContextConsumer`, its functionality remains similar.
+ *
  * A decorator or higher order component that makes a component `bidirectional`.
  *
  * As a HOC:
@@ -26,8 +29,8 @@ declare type BidirectionalType = {
  * export default bidirectional()(Example)
  * ```
  *
- * When used as a child of [ApplyTextDirection](#ApplyTextDirection), bidirectional components use
- * the direction provided in the context. When used without [ApplyTextDirection](#ApplyTextDirection),
+ * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), bidirectional components use
+ * the direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),
  * the direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,
  * bidirectional components query the documentElement for the `dir` attribute, defaulting to `ltr`
  * if it is not present.

package/types/bidirectional.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bidirectional.d.ts","sourceRoot":"","sources":["../src/bidirectional.tsx"],"names":[],"mappings":"AAyBA,OAAO,EAAE,SAAS,EAAwB,MAAM,wBAAwB,CAAA;AAOxE,oBAAY,kBAAkB,GAAG;IAC/B,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;CACpB,CAAA;AAMD,aAAK,iBAAiB,GAAG;IAEvB,IAAI,CAAC,iBAAiB,EAAE,GAAG,KAAK,GAAG,CAAA;IACnC,SAAS,EAAE,OAAO,SAAS,CAAA;CAC5B,CAAA;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,QAAA,MAAM,aAAa,EAAE,iBA4BE,CAAA;AAGvB,eAAe,aAAa,CAAA;AAC5B,OAAO,EAAE,aAAa,EAAE,CAAA"}
+{"version":3,"file":"bidirectional.d.ts","sourceRoot":"","sources":["../src/bidirectional.tsx"],"names":[],"mappings":"AAyBA,OAAO,EAAE,SAAS,EAAwB,MAAM,wBAAwB,CAAA;AAOxE,oBAAY,kBAAkB,GAAG;IAC/B,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;CACpB,CAAA;AAMD,aAAK,iBAAiB,GAAG;IAEvB,IAAI,CAAC,iBAAiB,EAAE,GAAG,KAAK,GAAG,CAAA;IACnC,SAAS,EAAE,OAAO,SAAS,CAAA;CAC5B,CAAA;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,QAAA,MAAM,aAAa,EAAE,iBAmCE,CAAA;AAIvB,eAAe,aAAa,CAAA;AAC5B,OAAO,EAAE,aAAa,EAAE,CAAA"}

package/types/getTextDirection.d.ts

@@ -3,10 +3,11 @@
  * category: utilities/i18n
  * ---
  *
- * Return the direction ('ltr' or 'rtl') of an element
+ * Return the direction ('ltr' or 'rtl' or 'auto') of an element. If no element
+ * is given, it returns the document's 'dir' value.
  * @module getTextDirection
  * @param {Element} element will use the <html> element by default
- * @returns {String} 'ltr' or 'rtl' (or `undefined` if no DOM is present)
+ * @returns {String} 'ltr' or 'rtl' or 'auto' (or `undefined` if no DOM is present)
  */
 declare function getTextDirection(element?: Element): "ltr" | "rtl" | "auto" | null | undefined;
 export default getTextDirection;

package/types/getTextDirection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getTextDirection.d.ts","sourceRoot":"","sources":["../src/getTextDirection.ts"],"names":[],"mappings":"AA6DA;;;;;;;;;GASG;AACH,iBAAS,gBAAgB,CAAC,OAAO,CAAC,EAAE,OAAO,6CAU1C;AACD,eAAe,gBAAgB,CAAA;AAC/B,OAAO,EAAE,gBAAgB,EAAE,CAAA"}
+{"version":3,"file":"getTextDirection.d.ts","sourceRoot":"","sources":["../src/getTextDirection.ts"],"names":[],"mappings":"AA6DA;;;;;;;;;;GAUG;AACH,iBAAS,gBAAgB,CAAC,OAAO,CAAC,EAAE,OAAO,6CAU1C;AACD,eAAe,gBAAgB,CAAA;AAC/B,OAAO,EAAE,gBAAgB,EAAE,CAAA"}

package/types/index.d.ts

@@ -1,12 +1,14 @@
 export { ApplyLocale } from './ApplyLocale';
 export { ApplyLocaleContext } from './ApplyLocale/ApplyLocaleContext';
 export { bidirectional } from './bidirectional';
+export { textDirectionContextConsumer } from './textDirectionContextConsumer';
 export { DateTime } from './DateTime';
 export { getTextDirection } from './getTextDirection';
 export { I18nPropTypes } from './I18nPropTypes';
 export { Locale } from './Locale';
 export { DIRECTION, TextDirectionContext } from './TextDirectionContext';
-export { useTextDirectionContext, ApplyTextDirection } from './ApplyTextDirection';
+export { ApplyTextDirection } from './ApplyTextDirection';
+export type { Moment } from './DateTime';
 export type { BidirectionalProps } from './bidirectional';
 export type { ApplyLocaleProps } from './ApplyLocale/props';
 export type { ApplyTextDirectionProps } from './ApplyTextDirection/props';

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAA;AAErE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AACxE,OAAO,EACL,uBAAuB,EACvB,kBAAkB,EACnB,MAAM,sBAAsB,CAAA;AAE7B,YAAY,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACzD,YAAY,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAC3D,YAAY,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAA;AAErE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAA;AAC7E,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAEzD,YAAY,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACxC,YAAY,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACzD,YAAY,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAC3D,YAAY,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAA"}

package/types/textDirectionContextConsumer.d.ts

@@ -0,0 +1,41 @@
+/**
+ * ---
+ * category: utilities/i18n
+ * ---
+ *
+ * A decorator or higher order component that supplies the text direction to
+ * components.
+ *
+ * As a HOC:
+ *
+ * ```js
+ * import { textDirectionContextConsumer } from '@instructure/ui-i18n'
+ *
+ * class Example extends React.Component {
+ *   render () {
+ *     return this.props.dir === textDirectionContextConsumer.DIRECTION.rtl ? <div>rtl</div> : <div>ltr</div>
+ *   }
+ * }
+ *
+ * export default textDirectionContextConsumer()(Example)
+ * ```
+ *
+ * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), bidirectional components use
+ * the direction provided in `TextDirectionContext`. When used without [InstUISettingsProvider](#InstUISettingsProvider),
+ * the direction can be supplied explicitly via the `dir` prop. If no `dir` prop is provided,
+ * bidirectional components query the documentElement for the `dir` attribute, defaulting to `ltr`
+ * if it is not present.
+ *
+ * @module textDirectionContextConsumer
+ * @return The decorator that composes the bidirectional component.
+ */
+declare const textDirectionContextConsumer: {
+    (): (ComposedComponent: any) => any;
+    DIRECTION: {
+        ltr: string;
+        rtl: string;
+    };
+};
+export default textDirectionContextConsumer;
+export { textDirectionContextConsumer };
+//# sourceMappingURL=textDirectionContextConsumer.d.ts.map

package/types/textDirectionContextConsumer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textDirectionContextConsumer.d.ts","sourceRoot":"","sources":["../src/textDirectionContextConsumer.tsx"],"names":[],"mappings":"AA0BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,QAAA,MAAM,4BAA4B;;;;;;CAAgB,CAAA;AAElD,eAAe,4BAA4B,CAAA;AAC3C,OAAO,EAAE,4BAA4B,EAAE,CAAA"}