@fluentui-react-native/framework 0.8.29 → 0.8.30

package/CHANGELOG.json

@@ -2,7 +2,22 @@
   "name": "@fluentui-react-native/framework",
   "entries": [
     {
-      "date": "Thu, 29 Dec 2022 03:44:56 GMT",
+      "date": "Fri, 30 Dec 2022 16:07:32 GMT",
+      "tag": "@fluentui-react-native/framework_v0.8.30",
+      "version": "0.8.30",
+      "comments": {
+        "patch": [
+          {
+            "author": "sanajmi@microsoft.com",
+            "package": "@fluentui-react-native/framework",
+            "commit": "8aefb1921c84f220ddf5c5def669c5ab9a036219",
+            "comment": "Update Compressible documentation"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 29 Dec 2022 03:47:47 GMT",
       "tag": "@fluentui-react-native/framework_v0.8.29",
       "version": "0.8.29",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,20 @@
 # Change Log - @fluentui-react-native/framework
 
-This log was last generated on Thu, 29 Dec 2022 03:44:56 GMT and should not be manually modified.
+This log was last generated on Fri, 30 Dec 2022 16:07:32 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.8.30
+
+Fri, 30 Dec 2022 16:07:32 GMT
+
+### Patches
+
+- Update Compressible documentation (sanajmi@microsoft.com)
+
 ## 0.8.29
 
-Thu, 29 Dec 2022 03:44:56 GMT
+Thu, 29 Dec 2022 03:47:47 GMT
 
 ### Patches
 

package/lib/compressible.d.ts

@@ -2,4 +2,11 @@ import { Theme } from '@fluentui-react-native/theme-types';
 import { StagedRender } from '@fluentui-react-native/use-slot';
 import { CustomizableComponent } from '@fluentui-react-native/use-tokens';
 import { UseTokens } from './useTokens';
+/**
+ * Utility function which can create function components that can be tree compressed (using the stagedRender pattern),
+ * and also have customize functionality.
+ * @param fn StagedRender function that defines your component
+ * @param useTokens a hook function to build a set of tokens from a passed in theme as well as a cache object
+ * @returns A tree compressed function component with the `.customize` method exposed to it
+ */
 export declare function compressible<TProps, TTokens>(fn: StagedRender<TProps>, useTokens: UseTokens<TTokens>): CustomizableComponent<TProps, TTokens, Theme>;

package/lib/compressible.js

@@ -1,4 +1,11 @@
 import { stagedComponent } from '@fluentui-react-native/use-slot';
+/**
+ * Utility function which can create function components that can be tree compressed (using the stagedRender pattern),
+ * and also have customize functionality.
+ * @param fn StagedRender function that defines your component
+ * @param useTokens a hook function to build a set of tokens from a passed in theme as well as a cache object
+ * @returns A tree compressed function component with the `.customize` method exposed to it
+ */
 export function compressible(fn, useTokens) {
     var injectedWrapper = function (props) { return fn(props, useTokens); };
     var component = stagedComponent(injectedWrapper);

package/lib/compressible.js.map

@@ -1 +1 @@
-{"version":3,"file":"compressible.js","sourceRoot":"","sources":["../src/compressible.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAgB,MAAM,iCAAiC,CAAC;AAKhF,MAAM,UAAU,YAAY,CAC1B,EAAwB,EACxB,SAA6B;IAI7B,IAAM,eAAe,GAAG,UAAC,KAAa,IAAK,OAAA,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,EAApB,CAAoB,CAAC;IAChE,IAAM,SAAS,GAAG,eAAe,CAAC,eAAe,CAAkB,CAAC;IAEpE,SAAS,CAAC,SAAS,GAAG;QAAC,gBAAmC;aAAnC,UAAmC,EAAnC,qBAAmC,EAAnC,IAAmC;YAAnC,2BAAmC;;QACxD,IAAM,YAAY,GAAG,SAAS,CAAC,SAAS,OAAnB,SAAS,EAAc,MAAM,CAAC,CAAC;QACpD,OAAO,YAAY,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IACxC,CAAC,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC"}
+{"version":3,"file":"compressible.js","sourceRoot":"","sources":["../src/compressible.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAgB,MAAM,iCAAiC,CAAC;AAKhF;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,EAAwB,EACxB,SAA6B;IAI7B,IAAM,eAAe,GAAG,UAAC,KAAa,IAAK,OAAA,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,EAApB,CAAoB,CAAC;IAChE,IAAM,SAAS,GAAG,eAAe,CAAC,eAAe,CAAkB,CAAC;IAEpE,SAAS,CAAC,SAAS,GAAG;QAAC,gBAAmC;aAAnC,UAAmC,EAAnC,qBAAmC,EAAnC,IAAmC;YAAnC,2BAAmC;;QACxD,IAAM,YAAY,GAAG,SAAS,CAAC,SAAS,OAAnB,SAAS,EAAc,MAAM,CAAC,CAAC;QACpD,OAAO,YAAY,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IACxC,CAAC,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/lib/useTokens.js.map

@@ -1 +1 @@
-{"version":3,"file":"useTokens.js","sourceRoot":"","sources":["../src/useTokens.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,IAAI,kBAAkB,EAA8B,MAAM,mCAAmC,CAAC;AACrH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAI5C,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAIpH,MAAM,UAAU,cAAc;IAAU,gBAAmC;SAAnC,UAAmC,EAAnC,qBAAmC,EAAnC,IAAmC;QAAnC,2BAAmC;;IACzE,OAAO,kBAAkB,8BAAC,WAAW,CAAC,gBAAgB,GAAK,MAAM,UAAE;AACrE,CAAC"}
+{"version":3,"file":"useTokens.js","sourceRoot":"","sources":["../src/useTokens.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,IAAI,kBAAkB,EAA8B,MAAM,mCAAmC,CAAC;AACrH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAI5C,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAKpH,MAAM,UAAU,cAAc;IAAU,gBAAmC;SAAnC,UAAmC,EAAnC,qBAAmC,EAAnC,IAAmC;QAAnC,2BAAmC;;IACzE,OAAO,kBAAkB,8BAAC,WAAW,CAAC,gBAAgB,GAAK,MAAM,UAAE;AACrE,CAAC"}

package/lib-commonjs/compressible.d.ts

@@ -2,4 +2,11 @@ import { Theme } from '@fluentui-react-native/theme-types';
 import { StagedRender } from '@fluentui-react-native/use-slot';
 import { CustomizableComponent } from '@fluentui-react-native/use-tokens';
 import { UseTokens } from './useTokens';
+/**
+ * Utility function which can create function components that can be tree compressed (using the stagedRender pattern),
+ * and also have customize functionality.
+ * @param fn StagedRender function that defines your component
+ * @param useTokens a hook function to build a set of tokens from a passed in theme as well as a cache object
+ * @returns A tree compressed function component with the `.customize` method exposed to it
+ */
 export declare function compressible<TProps, TTokens>(fn: StagedRender<TProps>, useTokens: UseTokens<TTokens>): CustomizableComponent<TProps, TTokens, Theme>;

package/lib-commonjs/compressible.js

@@ -2,6 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.compressible = void 0;
 var use_slot_1 = require("@fluentui-react-native/use-slot");
+/**
+ * Utility function which can create function components that can be tree compressed (using the stagedRender pattern),
+ * and also have customize functionality.
+ * @param fn StagedRender function that defines your component
+ * @param useTokens a hook function to build a set of tokens from a passed in theme as well as a cache object
+ * @returns A tree compressed function component with the `.customize` method exposed to it
+ */
 function compressible(fn, useTokens) {
     var injectedWrapper = function (props) { return fn(props, useTokens); };
     var component = (0, use_slot_1.stagedComponent)(injectedWrapper);

package/lib-commonjs/compressible.js.map

@@ -1 +1 @@
-{"version":3,"file":"compressible.js","sourceRoot":"","sources":["../src/compressible.ts"],"names":[],"mappings":";;;AACA,4DAAgF;AAKhF,SAAgB,YAAY,CAC1B,EAAwB,EACxB,SAA6B;IAI7B,IAAM,eAAe,GAAG,UAAC,KAAa,IAAK,OAAA,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,EAApB,CAAoB,CAAC;IAChE,IAAM,SAAS,GAAG,IAAA,0BAAe,EAAC,eAAe,CAAkB,CAAC;IAEpE,SAAS,CAAC,SAAS,GAAG;QAAC,gBAAmC;aAAnC,UAAmC,EAAnC,qBAAmC,EAAnC,IAAmC;YAAnC,2BAAmC;;QACxD,IAAM,YAAY,GAAG,SAAS,CAAC,SAAS,OAAnB,SAAS,EAAc,MAAM,CAAC,CAAC;QACpD,OAAO,YAAY,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IACxC,CAAC,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC;AAfD,oCAeC"}
+{"version":3,"file":"compressible.js","sourceRoot":"","sources":["../src/compressible.ts"],"names":[],"mappings":";;;AACA,4DAAgF;AAKhF;;;;;;GAMG;AACH,SAAgB,YAAY,CAC1B,EAAwB,EACxB,SAA6B;IAI7B,IAAM,eAAe,GAAG,UAAC,KAAa,IAAK,OAAA,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,EAApB,CAAoB,CAAC;IAChE,IAAM,SAAS,GAAG,IAAA,0BAAe,EAAC,eAAe,CAAkB,CAAC;IAEpE,SAAS,CAAC,SAAS,GAAG;QAAC,gBAAmC;aAAnC,UAAmC,EAAnC,qBAAmC,EAAnC,IAAmC;YAAnC,2BAAmC;;QACxD,IAAM,YAAY,GAAG,SAAS,CAAC,SAAS,OAAnB,SAAS,EAAc,MAAM,CAAC,CAAC;QACpD,OAAO,YAAY,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IACxC,CAAC,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC;AAfD,oCAeC"}

package/lib-commonjs/useTokens.js.map

@@ -1 +1 @@
-{"version":3,"file":"useTokens.js","sourceRoot":"","sources":["../src/useTokens.ts"],"names":[],"mappings":";;;;AAAA,gEAAqH;AACrH,6CAA4C;AAI5C,gEAAoH;AAA3G,8GAAA,gBAAgB,OAAA;AAAE,gHAAA,kBAAkB,OAAA;AAAE,0GAAA,YAAY,OAAA;AAAE,yGAAA,WAAW,OAAA;AAIxE,SAAgB,cAAc;IAAU,gBAAmC;SAAnC,UAAmC,EAAnC,qBAAmC,EAAnC,IAAmC;QAAnC,2BAAmC;;IACzE,OAAO,2BAAkB,2CAAC,yBAAW,CAAC,gBAAgB,GAAK,MAAM,UAAE;AACrE,CAAC;AAFD,wCAEC"}
+{"version":3,"file":"useTokens.js","sourceRoot":"","sources":["../src/useTokens.ts"],"names":[],"mappings":";;;;AAAA,gEAAqH;AACrH,6CAA4C;AAI5C,gEAAoH;AAA3G,8GAAA,gBAAgB,OAAA;AAAE,gHAAA,kBAAkB,OAAA;AAAE,0GAAA,YAAY,OAAA;AAAE,yGAAA,WAAW,OAAA;AAKxE,SAAgB,cAAc;IAAU,gBAAmC;SAAnC,UAAmC,EAAnC,qBAAmC,EAAnC,IAAmC;QAAnC,2BAAmC;;IACzE,OAAO,2BAAkB,2CAAC,yBAAW,CAAC,gBAAgB,GAAK,MAAM,UAAE;AACrE,CAAC;AAFD,wCAEC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluentui-react-native/framework",
-  "version": "0.8.29",
+  "version": "0.8.30",
   "description": "Component framework used by fluentui react native controls",
   "main": "lib-commonjs/index.js",
   "module": "lib/index.js",

package/src/compressible.ts

@@ -1,9 +1,16 @@
 import { Theme } from '@fluentui-react-native/theme-types';
 import { stagedComponent, StagedRender } from '@fluentui-react-native/use-slot';
 import { CustomizableComponent } from '@fluentui-react-native/use-tokens';
-import { UseTokens } from './useTokens';
 import { TokenSettings } from './useStyling';
+import { UseTokens } from './useTokens';
 
+/**
+ * Utility function which can create function components that can be tree compressed (using the stagedRender pattern),
+ * and also have customize functionality.
+ * @param fn StagedRender function that defines your component
+ * @param useTokens a hook function to build a set of tokens from a passed in theme as well as a cache object
+ * @returns A tree compressed function component with the `.customize` method exposed to it
+ */
 export function compressible<TProps, TTokens>(
   fn: StagedRender<TProps>,
   useTokens: UseTokens<TTokens>,

package/src/useTokens.ts

@@ -5,6 +5,7 @@ import { TokenSettings } from './useStyling';
 
 export { applyTokenLayers, applyPropsToTokens, customizable, patchTokens } from '@fluentui-react-native/use-tokens';
 
+// A hook function to build a set of tokens from a passed in theme as well as a cache object
 export type UseTokens<TTokens> = UseTokensCore<TTokens, Theme>;
 
 export function buildUseTokens<TTokens>(...tokens: TokenSettings<TTokens>[]): UseTokens<TTokens> {