@fluentui/react-portal-compat-context 0.0.0-nightly-20220503-0421.1

package/CHANGELOG.json

@@ -0,0 +1,26 @@
+{
+  "name": "@fluentui/react-portal-compat-context",
+  "entries": [
+    {
+      "date": "Tue, 03 May 2022 04:34:44 GMT",
+      "tag": "@fluentui/react-portal-compat-context_v0.0.0-nightly-20220503-0421.1",
+      "version": "0.0.0-nightly-20220503-0421.1",
+      "comments": {
+        "prerelease": [
+          {
+            "author": "email not defined",
+            "package": "@fluentui/react-portal-compat-context",
+            "commit": "not available",
+            "comment": "Release nightly v9"
+          },
+          {
+            "author": "olfedias@microsoft.com",
+            "package": "@fluentui/react-portal-compat-context",
+            "commit": "280cf2336d814d7380d5cbf4999ce56da763919c",
+            "comment": "initial release"
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log - @fluentui/react-portal-compat-context
+
+This log was last generated on Tue, 03 May 2022 04:34:44 GMT and should not be manually modified.
+
+<!-- Start content -->
+
+## [0.0.0-nightly-20220503-0421.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-portal-compat-context_v0.0.0-nightly-20220503-0421.1)
+
+Tue, 03 May 2022 04:34:44 GMT
+
+### Changes
+
+- Release nightly v9 ([commit](https://github.com/microsoft/fluentui/commit/not available) by email not defined)
+- initial release ([PR #22510](https://github.com/microsoft/fluentui/pull/22510) by olfedias@microsoft.com)

package/LICENSE

@@ -0,0 +1,15 @@
+@fluentui/react-portal-compat-context
+
+Copyright (c) Microsoft Corporation
+
+All rights reserved.
+
+MIT License
+
+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.
+
+Note: Usage of the fonts and icons referenced in Fluent UI React is subject to the terms listed at https://aka.ms/fluentui-assets-license

package/README.md

@@ -0,0 +1,48 @@
+# @fluentui/react-portal-compat-context
+
+This package contains the React Context for compat layer in `@fluentui/react-portal-compat`.
+
+### Installation
+
+```sh
+yarn add @fluentui/react-portal-compat-context
+```
+
+### Usage
+
+> **Note:** These APIs are intended to be used by library developers, please use `@fluentui/react-portal-compat` if you need Portal compatibility.
+>
+> `PortalCompatContextProvider` and `usePortalCompat()` are exported APIs for implementing compat layer.
+
+```tsx
+import { PortalCompatContextProvider, usePortalCompat } from '@fluentui/react-portal-compat-context';
+
+function Consumer() {
+  const registerEl = usePortalCompat();
+
+  React.useEffect(() => {
+    const portalEl = document.createElement('div');
+
+    return registerEl(portalEl);
+  }, [registerEl]);
+
+  return null;
+}
+
+function App() {
+  const registerEl = React.useCallback((portalEl: HTMLElement) => {
+    // do something...
+    console.log(portalEl);
+
+    return () => {
+      // do something for cleanups...
+    };
+  }, []);
+
+  return (
+    <PortalCompatContextProvider value={registerEl}>
+      <Consumer />
+    </PortalCompatContextProvider>
+  );
+}
+```

package/Spec.md

@@ -0,0 +1,63 @@
+# @fluentui/react-portal-compat-context Spec
+
+## Background
+
+_Description and use cases of this component_
+
+## Prior Art
+
+_Include background research done for this component_
+
+- _Link to Open UI research_
+- _Link to comparison of v7 and v0_
+- _Link to GitHub epic issue for the converged component_
+
+## Sample Code
+
+_Provide some representative example code that uses the proposed API for the component_
+
+## Variants
+
+_Describe visual or functional variants of this control, if applicable. For example, a slider could have a 2D variant._
+
+## API
+
+_List the **Props** and **Slots** proposed for the component. Ideally this would just be a link to the component's `.types.ts` file_
+
+## Structure
+
+- _**Public**_
+- _**Internal**_
+- _**DOM** - how the component will be rendered as HTML elements_
+
+## Migration
+
+_Describe what will need to be done to upgrade from the existing implementations:_
+
+- _Migration from v8_
+- _Migration from v0_
+
+## Behaviors
+
+_Explain how the component will behave in use, including:_
+
+- _Component States_
+- _Interaction_
+  - _Keyboard_
+  - _Cursor_
+  - _Touch_
+  - _Screen readers_
+
+## Accessibility
+
+Base accessibility information is included in the design document. After the spec is filled and review, outcomes from it need to be communicated to design and incorporated in the design document.
+
+- Decide whether to use **native element** or folow **ARIA** and provide reasons
+- Identify the **[ARIA](https://www.w3.org/TR/wai-aria-practices-1.2/) pattern** and, if the component is listed there, follow its specification as possible.
+- Identify accessibility **variants**, the `role` ([ARIA roles](https://www.w3.org/TR/wai-aria-1.1/#role_definitions)) of the component, its `slots` and `aria-*` props.
+- Describe the **keyboard navigation**: Tab Oder and Arrow Key Navigation. Describe any other keyboard **shortcuts** used
+- Specify texts for **state change announcements** - [ARIA live regions
+  ](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions) (number of available items in dropdown, error messages, confirmations, ...)
+- Identify UI parts that appear on **hover or focus** and specify keyboard and screen reader interaction with them
+- List cases when **focus** needs to be **trapped** in sections of the UI (for dialogs and popups or for hierarchical navigation)
+- List cases when **focus** needs to be **moved programatically** (if parts of the UI are appearing/disappearing or other cases)

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import * as React_2 from 'react';
+
+export declare const PortalCompatContextProvider: React_2.Provider<RegisterPortalFn>;
+
+export declare type RegisterPortalFn = (el: HTMLElement) => () => void;
+
+export declare function usePortalCompat(): RegisterPortalFn;
+
+export { }

package/lib/PortalCompatContext.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import type { RegisterPortalFn } from './types';
+export declare const PortalCompatContextProvider: React.Provider<RegisterPortalFn>;
+export declare function usePortalCompat(): RegisterPortalFn;

package/lib/PortalCompatContext.js

@@ -0,0 +1,10 @@
+import * as React from 'react';
+var PortalCompatContext = /*#__PURE__*/React.createContext( // eslint-disable-next-line @typescript-eslint/no-empty-function
+function () {
+  return function () {};
+});
+export var PortalCompatContextProvider = PortalCompatContext.Provider;
+export function usePortalCompat() {
+  return React.useContext(PortalCompatContext);
+}
+//# sourceMappingURL=PortalCompatContext.js.map

package/lib/PortalCompatContext.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["PortalCompatContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AAGA,IAAM,mBAAmB,gBAAG,KAAK,CAAC,aAAN,EAC1B;AACA,YAAA;AAAM,SAAA,YAAA,CAAA,CAAA;AAAQ,CAFY,CAA5B;AAKA,OAAO,IAAM,2BAA2B,GAAG,mBAAmB,CAAC,QAAxD;AAEP,OAAM,SAAU,eAAV,GAAyB;AAC7B,SAAO,KAAK,CAAC,UAAN,CAAiB,mBAAjB,CAAP;AACD","sourcesContent":["import * as React from 'react';\nimport type { RegisterPortalFn } from './types';\n\nconst PortalCompatContext = React.createContext<RegisterPortalFn>(\n  // eslint-disable-next-line @typescript-eslint/no-empty-function\n  () => () => {},\n);\n\nexport const PortalCompatContextProvider = PortalCompatContext.Provider;\n\nexport function usePortalCompat() {\n  return React.useContext(PortalCompatContext);\n}\n"],"sourceRoot":"../src/"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { PortalCompatContextProvider, usePortalCompat } from './PortalCompatContext';
+export type { RegisterPortalFn } from './types';

package/lib/index.js

@@ -0,0 +1,2 @@
+export { PortalCompatContextProvider, usePortalCompat } from './PortalCompatContext';
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"../src/","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC","sourcesContent":["export { PortalCompatContextProvider, usePortalCompat } from './PortalCompatContext';\nexport type { RegisterPortalFn } from './types';\n"]}

package/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.18.1"
+    }
+  ]
+}

package/lib/types.d.ts

@@ -0,0 +1 @@
+export declare type RegisterPortalFn = (el: HTMLElement) => () => void;

package/lib/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"../src/","sources":["types.ts"],"names":[],"mappings":"","sourcesContent":["export type RegisterPortalFn = (el: HTMLElement) => () => void;\n"]}

package/lib-commonjs/PortalCompatContext.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import type { RegisterPortalFn } from './types';
+export declare const PortalCompatContextProvider: React.Provider<RegisterPortalFn>;
+export declare function usePortalCompat(): RegisterPortalFn;

package/lib-commonjs/PortalCompatContext.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.usePortalCompat = exports.PortalCompatContextProvider = void 0;
+
+var React = /*#__PURE__*/require("react");
+
+var PortalCompatContext = /*#__PURE__*/React.createContext( // eslint-disable-next-line @typescript-eslint/no-empty-function
+function () {
+  return function () {};
+});
+exports.PortalCompatContextProvider = PortalCompatContext.Provider;
+
+function usePortalCompat() {
+  return React.useContext(PortalCompatContext);
+}
+
+exports.usePortalCompat = usePortalCompat;
+//# sourceMappingURL=PortalCompatContext.js.map

package/lib-commonjs/PortalCompatContext.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["PortalCompatContext.ts"],"names":[],"mappings":";;;;;;;AAAA,IAAA,KAAA,gBAAA,OAAA,CAAA,OAAA,CAAA;;AAGA,IAAM,mBAAmB,gBAAG,KAAK,CAAC,aAAN,EAC1B;AACA,YAAA;AAAM,SAAA,YAAA,CAAA,CAAA;AAAQ,CAFY,CAA5B;AAKa,OAAA,CAAA,2BAAA,GAA8B,mBAAmB,CAAC,QAAlD;;AAEb,SAAgB,eAAhB,GAA+B;AAC7B,SAAO,KAAK,CAAC,UAAN,CAAiB,mBAAjB,CAAP;AACD;;AAFD,OAAA,CAAA,eAAA,GAAA,eAAA","sourcesContent":["import * as React from 'react';\nimport type { RegisterPortalFn } from './types';\n\nconst PortalCompatContext = React.createContext<RegisterPortalFn>(\n  // eslint-disable-next-line @typescript-eslint/no-empty-function\n  () => () => {},\n);\n\nexport const PortalCompatContextProvider = PortalCompatContext.Provider;\n\nexport function usePortalCompat() {\n  return React.useContext(PortalCompatContext);\n}\n"],"sourceRoot":"../src/"}

package/lib-commonjs/index.d.ts

@@ -0,0 +1,2 @@
+export { PortalCompatContextProvider, usePortalCompat } from './PortalCompatContext';
+export type { RegisterPortalFn } from './types';

package/lib-commonjs/index.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.usePortalCompat = exports.PortalCompatContextProvider = void 0;
+
+var PortalCompatContext_1 = /*#__PURE__*/require("./PortalCompatContext");
+
+Object.defineProperty(exports, "PortalCompatContextProvider", {
+  enumerable: true,
+  get: function () {
+    return PortalCompatContext_1.PortalCompatContextProvider;
+  }
+});
+Object.defineProperty(exports, "usePortalCompat", {
+  enumerable: true,
+  get: function () {
+    return PortalCompatContext_1.usePortalCompat;
+  }
+});
+//# sourceMappingURL=index.js.map

package/lib-commonjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["index.ts"],"names":[],"mappings":";;;;;;;AAAA,IAAA,qBAAA,gBAAA,OAAA,CAAA,uBAAA,CAAA;;AAAS,MAAA,CAAA,cAAA,CAAA,OAAA,EAAA,6BAAA,EAAA;AAAA,EAAA,UAAA,EAAA,IAAA;AAAA,EAAA,GAAA,EAAA,YAAA;AAAA,WAAA,qBAAA,CAAA,2BAAA;AAA2B;AAA3B,CAAA;AAA6B,MAAA,CAAA,cAAA,CAAA,OAAA,EAAA,iBAAA,EAAA;AAAA,EAAA,UAAA,EAAA,IAAA;AAAA,EAAA,GAAA,EAAA,YAAA;AAAA,WAAA,qBAAA,CAAA,eAAA;AAAe;AAAf,CAAA","sourcesContent":["export { PortalCompatContextProvider, usePortalCompat } from './PortalCompatContext';\nexport type { RegisterPortalFn } from './types';\n"],"sourceRoot":"../src/"}

package/lib-commonjs/types.d.ts

@@ -0,0 +1 @@
+export declare type RegisterPortalFn = (el: HTMLElement) => () => void;

package/lib-commonjs/types.js

@@ -0,0 +1,6 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+//# sourceMappingURL=types.js.map

package/lib-commonjs/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourceRoot":"../src/"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@fluentui/react-portal-compat-context",
+  "version": "0.0.0-nightly-20220503-0421.1",
+  "description": "A package that holds React context for compatibility of React Contexts",
+  "main": "lib-commonjs/index.js",
+  "module": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/fluentui"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "just-scripts build",
+    "clean": "just-scripts clean",
+    "code-style": "just-scripts code-style",
+    "just": "just-scripts",
+    "lint": "just-scripts lint",
+    "start": "yarn storybook",
+    "test": "jest --passWithNoTests",
+    "docs": "api-extractor run --config=config/api-extractor.local.json --local",
+    "build:local": "tsc -p ./tsconfig.lib.json --module esnext --emitDeclarationOnly && node ../../scripts/typescript/normalize-import --output ./dist/packages/react-portal-compat-context/src && yarn docs",
+    "storybook": "node ../../scripts/storybook/runner",
+    "type-check": "tsc -b tsconfig.json"
+  },
+  "devDependencies": {
+    "@fluentui/eslint-plugin": "*",
+    "@fluentui/scripts": "^1.0.0"
+  },
+  "dependencies": {
+    "tslib": "^2.1.0"
+  },
+  "peerDependencies": {
+    "@types/react": ">=16.8.0 <18.0.0",
+    "react": ">=16.8.0 <18.0.0"
+  },
+  "beachball": {
+    "disallowedChangeTypes": [
+      "major",
+      "minor",
+      "patch"
+    ]
+  }
+}