@instructure/ui-i18n 8.56.0 → 9.0.0

package/types/index.d.ts

@@ -1,15 +1,12 @@
 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 { ApplyTextDirection } from './ApplyTextDirection';
 export type { Moment } from './DateTime';
-export type { BidirectionalProps } from './bidirectional';
+export type { TextDirectionContextConsumerProps } from './textDirectionContextConsumer';
 export type { ApplyLocaleProps } from './ApplyLocale/props';
-export type { ApplyTextDirectionProps } from './ApplyTextDirection/props';
 //# sourceMappingURL=index.d.ts.map

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,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"}
+{"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,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;AAExE,YAAY,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACxC,YAAY,EAAE,iCAAiC,EAAE,MAAM,gCAAgC,CAAA;AACvF,YAAY,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA"}

package/types/textDirectionContextConsumer.d.ts

@@ -1,3 +1,12 @@
+import { PropsWithChildren } from 'react';
+import { DIRECTION } from './TextDirectionContext';
+export type TextDirectionContextConsumerProps = PropsWithChildren<{
+    dir?: 'ltr' | 'rtl';
+}>;
+type TextDirectionContextConsumerType = {
+    (): (ComposedComponent: any) => any;
+    DIRECTION: typeof DIRECTION;
+};
 /**
  * ---
  * category: utilities/i18n
@@ -20,22 +29,16 @@
  * export default textDirectionContextConsumer()(Example)
  * ```
  *
- * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), bidirectional components use
+ * When used as a child of [InstUISettingsProvider](#InstUISettingsProvider), textDirectionContextConsumer 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`
+ * textDirectionContextConsumer 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.
+ * @return The decorator that composes the textDirectionContextConsumer component.
  */
-declare const textDirectionContextConsumer: {
-    (): (ComposedComponent: any) => any;
-    DIRECTION: {
-        ltr: string;
-        rtl: string;
-    };
-};
+declare const textDirectionContextConsumer: TextDirectionContextConsumerType;
 export default textDirectionContextConsumer;
 export { textDirectionContextConsumer };
 //# sourceMappingURL=textDirectionContextConsumer.d.ts.map

package/types/textDirectionContextConsumer.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"textDirectionContextConsumer.d.ts","sourceRoot":"","sources":["../src/textDirectionContextConsumer.tsx"],"names":[],"mappings":"AAuBA,OAAc,EAA4B,iBAAiB,EAAE,MAAM,OAAO,CAAA;AAO1E,OAAO,EAAE,SAAS,EAAwB,MAAM,wBAAwB,CAAA;AAOxE,MAAM,MAAM,iCAAiC,GAAG,iBAAiB,CAAC;IAChE,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;CACpB,CAAC,CAAA;AAMF,KAAK,gCAAgC,GAAG;IAEtC,IAAI,CAAC,iBAAiB,EAAE,GAAG,KAAK,GAAG,CAAA;IACnC,SAAS,EAAE,OAAO,SAAS,CAAA;CAC5B,CAAA;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,QAAA,MAAM,4BAA4B,EAAE,gCA0DI,CAAA;AAIxC,eAAe,4BAA4B,CAAA;AAC3C,OAAO,EAAE,4BAA4B,EAAE,CAAA"}

package/es/ApplyTextDirection/index.js

@@ -1,49 +0,0 @@
-/*
- * 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 React, { useContext } from 'react';
-import { getElementType } from '@instructure/ui-react-utils';
-import { DIRECTION, TextDirectionContext } from '../TextDirectionContext';
-/**
----
-category: components/utilities
----
-DEPRECATED. Please use TextDirectionContext instead.
-**/
-const ApplyTextDirection = props => {
-  const context = useContext(TextDirectionContext);
-  const dir = props.dir || context;
-  const ElementType = getElementType(ApplyTextDirection, props);
-  return /*#__PURE__*/React.createElement(TextDirectionContext.Provider, {
-    value: dir
-  }, /*#__PURE__*/React.createElement(ElementType, {
-    dir: dir
-  }, typeof props.children === 'function' ? props.children(dir, dir === DIRECTION.rtl) : props.children));
-};
-ApplyTextDirection.defaultProps = {
-  dir: void 0,
-  as: 'span',
-  children: null
-};
-export { ApplyTextDirection };

package/es/ApplyTextDirection/props.js

@@ -1 +0,0 @@
-export {};

package/es/bidirectional.js

@@ -1,111 +0,0 @@
-import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
-const _excluded = ["forwardedRef"];
-/*
- * 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 React, { forwardRef } from 'react';
-import { decorator } from '@instructure/ui-decorator';
-import { DIRECTION, TextDirectionContext } from './TextDirectionContext';
-import hoistNonReactStatics from 'hoist-non-react-statics';
-
-// This is a workaround because TS cannot take type information from
-// decorators into account. This type needs to be added to every component,
-// that uses the bidirectional decorator.
-// see https://github.com/microsoft/TypeScript/issues/4881
-/**
- * ---
- * 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:
- *
- * ```js-code
- * import { bidirectional } from '@instructure/ui-i18n'
- *
- * class Example extends React.Component {
- *   render () {
- *     return this.props.dir === bidirectional.DIRECTION.rtl ? <div>rtl</div> : <div>ltr</div>
- *   }
- * }
- *
- * export default bidirectional()(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 bidirectional
- * @return The decorator that composes the bidirectional component.
- */
-const bidirectional = decorator(ComposedComponent => {
-  class BidirectionalComponent extends React.Component {
-    render() {
-      const _this$props = this.props,
-        forwardedRef = _this$props.forwardedRef,
-        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 => {
-        if (process.env.NODE_ENV !== 'production' && dir === 'auto') {}
-        return /*#__PURE__*/React.createElement(ComposedComponent, Object.assign({
-          ref: forwardedRef,
-          dir: dir
-        }, rest));
-      });
-    }
-  }
-  BidirectionalComponent.displayName = "BidirectionalComponent";
-  const BidirectionalForwardingRef = /*#__PURE__*/forwardRef((props, ref) => /*#__PURE__*/React.createElement(BidirectionalComponent, Object.assign({}, props, {
-    forwardedRef: ref
-  })));
-  if (process.env.NODE_ENV !== 'production') {
-    const displayName = ComposedComponent.displayName || ComposedComponent.name;
-    BidirectionalForwardingRef.displayName = `BidirectionalForwardingRef(${displayName})`;
-  }
-  hoistNonReactStatics(BidirectionalForwardingRef, ComposedComponent);
-  BidirectionalForwardingRef.defaultProps = ComposedComponent.defaultProps;
-  // eslint-disable-next-line react/forbid-foreign-prop-types
-  BidirectionalForwardingRef.propTypes = ComposedComponent.propTypes;
-  // @ts-expect-error These static fields exist on InstUI components
-  BidirectionalForwardingRef.allowedProps = ComposedComponent.allowedProps;
-
-  // added so it can be tested with ReactTestUtils
-  // more info: https://github.com/facebook/react/issues/13455
-  BidirectionalForwardingRef.originalType = ComposedComponent.originalType || ComposedComponent;
-  return BidirectionalForwardingRef;
-});
-bidirectional.DIRECTION = DIRECTION;
-export default bidirectional;
-export { bidirectional };

package/lib/ApplyTextDirection/index.js

@@ -1,56 +0,0 @@
-"use strict";
-
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.ApplyTextDirection = void 0;
-var _react = _interopRequireWildcard(require("react"));
-var _getElementType = require("@instructure/ui-react-utils/lib/getElementType.js");
-var _TextDirectionContext = require("../TextDirectionContext");
-/*
- * 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: components/utilities
----
-DEPRECATED. Please use TextDirectionContext instead.
-**/
-const ApplyTextDirection = props => {
-  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, {
-    value: dir
-  }, /*#__PURE__*/_react.default.createElement(ElementType, {
-    dir: dir
-  }, typeof props.children === 'function' ? props.children(dir, dir === _TextDirectionContext.DIRECTION.rtl) : props.children));
-};
-exports.ApplyTextDirection = ApplyTextDirection;
-ApplyTextDirection.defaultProps = {
-  dir: void 0,
-  as: 'span',
-  children: null
-};

package/lib/ApplyTextDirection/props.js

@@ -1,5 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});

package/lib/bidirectional.js

@@ -1,117 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = exports.bidirectional = void 0;
-var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
-var _react = _interopRequireWildcard(require("react"));
-var _decorator = require("@instructure/ui-decorator/lib/decorator.js");
-var _TextDirectionContext = require("./TextDirectionContext");
-var _hoistNonReactStatics = _interopRequireDefault(require("hoist-non-react-statics"));
-const _excluded = ["forwardedRef"];
-/*
- * 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.
- */
-// This is a workaround because TS cannot take type information from
-// decorators into account. This type needs to be added to every component,
-// that uses the bidirectional decorator.
-// see https://github.com/microsoft/TypeScript/issues/4881
-/**
- * ---
- * 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:
- *
- * ```js-code
- * import { bidirectional } from '@instructure/ui-i18n'
- *
- * class Example extends React.Component {
- *   render () {
- *     return this.props.dir === bidirectional.DIRECTION.rtl ? <div>rtl</div> : <div>ltr</div>
- *   }
- * }
- *
- * export default bidirectional()(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 bidirectional
- * @return The decorator that composes the bidirectional component.
- */
-const bidirectional = exports.bidirectional = (0, _decorator.decorator)(ComposedComponent => {
-  class BidirectionalComponent extends _react.default.Component {
-    render() {
-      const _this$props = this.props,
-        forwardedRef = _this$props.forwardedRef,
-        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 => {
-        if (process.env.NODE_ENV !== 'production' && dir === 'auto') {}
-        return /*#__PURE__*/_react.default.createElement(ComposedComponent, Object.assign({
-          ref: forwardedRef,
-          dir: dir
-        }, rest));
-      });
-    }
-  }
-  BidirectionalComponent.displayName = "BidirectionalComponent";
-  const BidirectionalForwardingRef = /*#__PURE__*/(0, _react.forwardRef)((props, ref) => /*#__PURE__*/_react.default.createElement(BidirectionalComponent, Object.assign({}, props, {
-    forwardedRef: ref
-  })));
-  if (process.env.NODE_ENV !== 'production') {
-    const displayName = ComposedComponent.displayName || ComposedComponent.name;
-    BidirectionalForwardingRef.displayName = `BidirectionalForwardingRef(${displayName})`;
-  }
-  (0, _hoistNonReactStatics.default)(BidirectionalForwardingRef, ComposedComponent);
-  BidirectionalForwardingRef.defaultProps = ComposedComponent.defaultProps;
-  // eslint-disable-next-line react/forbid-foreign-prop-types
-  BidirectionalForwardingRef.propTypes = ComposedComponent.propTypes;
-  // @ts-expect-error These static fields exist on InstUI components
-  BidirectionalForwardingRef.allowedProps = ComposedComponent.allowedProps;
-
-  // added so it can be tested with ReactTestUtils
-  // more info: https://github.com/facebook/react/issues/13455
-  BidirectionalForwardingRef.originalType = ComposedComponent.originalType || ComposedComponent;
-  return BidirectionalForwardingRef;
-});
-bidirectional.DIRECTION = _TextDirectionContext.DIRECTION;
-var _default = exports.default = bidirectional;

package/src/ApplyTextDirection/README.md

@@ -1,62 +0,0 @@
----
-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).
-
-If no `dir` prop is supplied, `<ApplyTextDirection />` will fallback to its parent context if it
-exists. Otherwise it queries for and uses the documentElement `dir` attribute and defaults to `ltr`
-if it is not found.
-
-```javascript
----
-type: example
----
-<ApplyTextDirection dir="rtl">
-  <View
-    display="block"
-    background="primary"
-    padding="large"
-    borderWidth="none none none large"
-  >
-    <Heading>Rtl Content</Heading>
-    {lorem.paragraph()}
-  </View>
-</ApplyTextDirection>
-```
-
-For exceptions, `<ApplyTextDirection />` can be nested and override parent context.
-
-```javascript
----
-type: example
----
-<ApplyTextDirection dir="rtl">
-  <View
-    display="block"
-    background="primary"
-    padding="large"
-    borderWidth="none none none large"
-  >
-    <Heading>Rtl Content</Heading>
-    {lorem.paragraph()}
-  </View>
-  <ApplyTextDirection dir="ltr">
-    <View
-      display="block"
-      background="primary"
-      padding="large"
-      borderWidth="none none none large"
-    >
-      <Heading>Ltr Content</Heading>
-      {lorem.paragraph()}
-    </View>
-  </ApplyTextDirection>
-</ApplyTextDirection>
-```

package/src/ApplyTextDirection/index.tsx

@@ -1,60 +0,0 @@
-/*
- * 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 React, { useContext } from 'react'
-import { getElementType } from '@instructure/ui-react-utils'
-
-import { DIRECTION, TextDirectionContext } from '../TextDirectionContext'
-import { ApplyTextDirectionProps } from './props'
-
-/**
----
-category: components/utilities
----
-DEPRECATED. Please use TextDirectionContext instead.
-**/
-const ApplyTextDirection = (props: ApplyTextDirectionProps) => {
-  const context = useContext(TextDirectionContext)
-  const dir = props.dir || context
-  const ElementType = getElementType(ApplyTextDirection, props)
-  return (
-    <TextDirectionContext.Provider value={dir}>
-      {
-        <ElementType dir={dir}>
-          {typeof props.children === 'function'
-            ? props.children(dir, dir === DIRECTION.rtl)
-            : props.children}
-        </ElementType>
-      }
-    </TextDirectionContext.Provider>
-  )
-}
-
-ApplyTextDirection.defaultProps = {
-  dir: undefined,
-  as: 'span',
-  children: null
-} as const
-
-export { ApplyTextDirection }

package/src/ApplyTextDirection/props.ts

@@ -1,45 +0,0 @@
-/*
- * 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 React from 'react'
-import { AsElementType } from '@instructure/shared-types'
-
-type DirValues = 'ltr' | 'rtl' | 'auto'
-
-export type ApplyTextDirectionProps = {
-  /**
-   * 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
-}