@fluentui/react-image 9.0.0-rc.6 → 9.0.0-rc.9

package/dist/{react-image.d.ts → index.d.ts}

@@ -18,37 +18,44 @@ export declare const imageClassName = "fui-Image";
 
 export declare const imageClassNames: SlotClassNames<ImageSlots>;
 
-declare type ImageCommons = {
+export declare type ImageProps = ComponentProps<ImageSlots> & {
     /**
-     * An image can appear with rectangular border.
+     * An image can take up the width of its container.
+     *
+     * @default false
+     */
+    block?: boolean;
+    /**
+     * An image can appear with a rectangular border.
+     *
+     * @default false
      */
     bordered?: boolean;
     /**
      * An image can set how it should be resized to fit its container.
+     *
+     * @default 'default'
      */
-    fit?: 'none' | 'center' | 'contain' | 'cover';
+    fit?: 'none' | 'center' | 'contain' | 'cover' | 'default';
     /**
-     * An image can take up the width of its container.
+     * An image can appear elevated with shadow.
+     *
+     * @default false
      */
-    block?: boolean;
+    shadow?: boolean;
     /**
      * An image can appear square, circular, or rounded.
-     * @defaultvalue square
+     *
+     * @default 'square'
      */
     shape?: 'square' | 'circular' | 'rounded';
-    /**
-     * An image can appear elevated with shadow.
-     */
-    shadow?: boolean;
 };
 
-export declare type ImageProps = ComponentProps<ImageSlots> & Partial<ImageCommons>;
-
 export declare type ImageSlots = {
     root: Slot<'img'>;
 };
 
-export declare type ImageState = ComponentState<ImageSlots> & ImageCommons;
+export declare type ImageState = ComponentState<ImageSlots> & Required<Pick<ImageProps, 'block' | 'bordered' | 'fit' | 'shadow' | 'shape'>>;
 
 /**
  * Define the render function.

package/lib/components/Image/Image.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"Image.types.js","sourceRoot":"../src/","sources":["components/Image/Image.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ComponentState, ComponentProps, Slot } from '@fluentui/react-utilities';\n\nexport type ImageSlots = {\n  root: Slot<'img'>;\n};\n\ntype ImageCommons = {\n  /**\n   * An image can appear with rectangular border.\n   */\n  bordered?: boolean;\n\n  /**\n   * An image can set how it should be resized to fit its container.\n   */\n  fit?: 'none' | 'center' | 'contain' | 'cover';\n\n  /**\n   * An image can take up the width of its container.\n   */\n  block?: boolean;\n\n  /**\n   * An image can appear square, circular, or rounded.\n   * @defaultvalue square\n   */\n  shape?: 'square' | 'circular' | 'rounded';\n\n  /**\n   * An image can appear elevated with shadow.\n   */\n  shadow?: boolean;\n};\n\nexport type ImageProps = ComponentProps<ImageSlots> & Partial<ImageCommons>;\n\nexport type ImageState = ComponentState<ImageSlots> & ImageCommons;\n"]}
+{"version":3,"file":"Image.types.js","sourceRoot":"../src/","sources":["components/Image/Image.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ComponentState, ComponentProps, Slot } from '@fluentui/react-utilities';\n\nexport type ImageSlots = {\n  root: Slot<'img'>;\n};\n\nexport type ImageProps = ComponentProps<ImageSlots> & {\n  /**\n   * An image can take up the width of its container.\n   *\n   * @default false\n   */\n  block?: boolean;\n\n  /**\n   * An image can appear with a rectangular border.\n   *\n   * @default false\n   */\n  bordered?: boolean;\n\n  /**\n   * An image can set how it should be resized to fit its container.\n   *\n   * @default 'default'\n   */\n  fit?: 'none' | 'center' | 'contain' | 'cover' | 'default';\n\n  /**\n   * An image can appear elevated with shadow.\n   *\n   * @default false\n   */\n  shadow?: boolean;\n\n  /**\n   * An image can appear square, circular, or rounded.\n   *\n   * @default 'square'\n   */\n  shape?: 'square' | 'circular' | 'rounded';\n};\n\nexport type ImageState = ComponentState<ImageSlots> &\n  Required<Pick<ImageProps, 'block' | 'bordered' | 'fit' | 'shadow' | 'shape'>>;\n"]}

package/lib/components/Image/useImage.js

@@ -5,11 +5,11 @@ import { getNativeElementProps } from '@fluentui/react-utilities';
 
 export const useImage_unstable = (props, ref) => {
   const {
-    bordered,
-    fit,
-    block,
+    bordered = false,
+    fit = 'default',
+    block = false,
     shape = 'square',
-    shadow
+    shadow = false
   } = props;
   const state = {
     bordered,

package/lib/components/Image/useImage.js.map

@@ -1 +1 @@
-{"version":3,"sources":["components/Image/useImage.ts"],"names":[],"mappings":"AACA,SAAS,qBAAT,QAAsC,2BAAtC;AAGA;;AAEG;;AACH,OAAO,MAAM,iBAAiB,GAAG,CAAC,KAAD,EAAoB,GAApB,KAAoE;AACnG,QAAM;AAAE,IAAA,QAAF;AAAY,IAAA,GAAZ;AAAiB,IAAA,KAAjB;AAAwB,IAAA,KAAK,GAAG,QAAhC;AAA0C,IAAA;AAA1C,MAAqD,KAA3D;AAEA,QAAM,KAAK,GAAe;AACxB,IAAA,QADwB;AAExB,IAAA,GAFwB;AAGxB,IAAA,KAHwB;AAIxB,IAAA,KAJwB;AAKxB,IAAA,MALwB;AAMxB,IAAA,UAAU,EAAE;AACV,MAAA,IAAI,EAAE;AADI,KANY;AASxB,IAAA,IAAI,EAAE,qBAAqB,CAAC,KAAD,EAAQ;AACjC,MAAA,GADiC;AAEjC,SAAG;AAF8B,KAAR;AATH,GAA1B;AAeA,SAAO,KAAP;AACD,CAnBM","sourcesContent":["import * as React from 'react';\nimport { getNativeElementProps } from '@fluentui/react-utilities';\nimport type { ImageProps, ImageState } from './Image.types';\n\n/**\n * Given user props, returns state and render function for an Image.\n */\nexport const useImage_unstable = (props: ImageProps, ref: React.Ref<HTMLImageElement>): ImageState => {\n  const { bordered, fit, block, shape = 'square', shadow } = props;\n\n  const state: ImageState = {\n    bordered,\n    fit,\n    block,\n    shape,\n    shadow,\n    components: {\n      root: 'img',\n    },\n    root: getNativeElementProps('img', {\n      ref,\n      ...props,\n    }),\n  };\n\n  return state;\n};\n"],"sourceRoot":"../src/"}
+{"version":3,"sources":["components/Image/useImage.ts"],"names":[],"mappings":"AACA,SAAS,qBAAT,QAAsC,2BAAtC;AAGA;;AAEG;;AACH,OAAO,MAAM,iBAAiB,GAAG,CAAC,KAAD,EAAoB,GAApB,KAAoE;AACnG,QAAM;AAAE,IAAA,QAAQ,GAAG,KAAb;AAAoB,IAAA,GAAG,GAAG,SAA1B;AAAqC,IAAA,KAAK,GAAG,KAA7C;AAAoD,IAAA,KAAK,GAAG,QAA5D;AAAsE,IAAA,MAAM,GAAG;AAA/E,MAAyF,KAA/F;AAEA,QAAM,KAAK,GAAe;AACxB,IAAA,QADwB;AAExB,IAAA,GAFwB;AAGxB,IAAA,KAHwB;AAIxB,IAAA,KAJwB;AAKxB,IAAA,MALwB;AAMxB,IAAA,UAAU,EAAE;AACV,MAAA,IAAI,EAAE;AADI,KANY;AASxB,IAAA,IAAI,EAAE,qBAAqB,CAAC,KAAD,EAAQ;AACjC,MAAA,GADiC;AAEjC,SAAG;AAF8B,KAAR;AATH,GAA1B;AAeA,SAAO,KAAP;AACD,CAnBM","sourcesContent":["import * as React from 'react';\nimport { getNativeElementProps } from '@fluentui/react-utilities';\nimport type { ImageProps, ImageState } from './Image.types';\n\n/**\n * Given user props, returns state and render function for an Image.\n */\nexport const useImage_unstable = (props: ImageProps, ref: React.Ref<HTMLImageElement>): ImageState => {\n  const { bordered = false, fit = 'default', block = false, shape = 'square', shadow = false } = props;\n\n  const state: ImageState = {\n    bordered,\n    fit,\n    block,\n    shape,\n    shadow,\n    components: {\n      root: 'img',\n    },\n    root: getNativeElementProps('img', {\n      ref,\n      ...props,\n    }),\n  };\n\n  return state;\n};\n"],"sourceRoot":"../src/"}

package/lib-commonjs/components/Image/useImage.js

@@ -13,11 +13,11 @@ const react_utilities_1 = /*#__PURE__*/require("@fluentui/react-utilities");
 
 const useImage_unstable = (props, ref) => {
   const {
-    bordered,
-    fit,
-    block,
+    bordered = false,
+    fit = 'default',
+    block = false,
     shape = 'square',
-    shadow
+    shadow = false
   } = props;
   const state = {
     bordered,

package/lib-commonjs/components/Image/useImage.js.map

@@ -1 +1 @@
-{"version":3,"sources":["components/Image/useImage.ts"],"names":[],"mappings":";;;;;;;AACA,MAAA,iBAAA,gBAAA,OAAA,CAAA,2BAAA,CAAA;AAGA;;AAEG;;;AACI,MAAM,iBAAiB,GAAG,CAAC,KAAD,EAAoB,GAApB,KAAoE;AACnG,QAAM;AAAE,IAAA,QAAF;AAAY,IAAA,GAAZ;AAAiB,IAAA,KAAjB;AAAwB,IAAA,KAAK,GAAG,QAAhC;AAA0C,IAAA;AAA1C,MAAqD,KAA3D;AAEA,QAAM,KAAK,GAAe;AACxB,IAAA,QADwB;AAExB,IAAA,GAFwB;AAGxB,IAAA,KAHwB;AAIxB,IAAA,KAJwB;AAKxB,IAAA,MALwB;AAMxB,IAAA,UAAU,EAAE;AACV,MAAA,IAAI,EAAE;AADI,KANY;AASxB,IAAA,IAAI,EAAE,iBAAA,CAAA,qBAAA,CAAsB,KAAtB,EAA6B;AACjC,MAAA,GADiC;AAEjC,SAAG;AAF8B,KAA7B;AATkB,GAA1B;AAeA,SAAO,KAAP;AACD,CAnBM;;AAAM,OAAA,CAAA,iBAAA,GAAiB,iBAAjB","sourcesContent":["import * as React from 'react';\nimport { getNativeElementProps } from '@fluentui/react-utilities';\nimport type { ImageProps, ImageState } from './Image.types';\n\n/**\n * Given user props, returns state and render function for an Image.\n */\nexport const useImage_unstable = (props: ImageProps, ref: React.Ref<HTMLImageElement>): ImageState => {\n  const { bordered, fit, block, shape = 'square', shadow } = props;\n\n  const state: ImageState = {\n    bordered,\n    fit,\n    block,\n    shape,\n    shadow,\n    components: {\n      root: 'img',\n    },\n    root: getNativeElementProps('img', {\n      ref,\n      ...props,\n    }),\n  };\n\n  return state;\n};\n"],"sourceRoot":"../src/"}
+{"version":3,"sources":["components/Image/useImage.ts"],"names":[],"mappings":";;;;;;;AACA,MAAA,iBAAA,gBAAA,OAAA,CAAA,2BAAA,CAAA;AAGA;;AAEG;;;AACI,MAAM,iBAAiB,GAAG,CAAC,KAAD,EAAoB,GAApB,KAAoE;AACnG,QAAM;AAAE,IAAA,QAAQ,GAAG,KAAb;AAAoB,IAAA,GAAG,GAAG,SAA1B;AAAqC,IAAA,KAAK,GAAG,KAA7C;AAAoD,IAAA,KAAK,GAAG,QAA5D;AAAsE,IAAA,MAAM,GAAG;AAA/E,MAAyF,KAA/F;AAEA,QAAM,KAAK,GAAe;AACxB,IAAA,QADwB;AAExB,IAAA,GAFwB;AAGxB,IAAA,KAHwB;AAIxB,IAAA,KAJwB;AAKxB,IAAA,MALwB;AAMxB,IAAA,UAAU,EAAE;AACV,MAAA,IAAI,EAAE;AADI,KANY;AASxB,IAAA,IAAI,EAAE,iBAAA,CAAA,qBAAA,CAAsB,KAAtB,EAA6B;AACjC,MAAA,GADiC;AAEjC,SAAG;AAF8B,KAA7B;AATkB,GAA1B;AAeA,SAAO,KAAP;AACD,CAnBM;;AAAM,OAAA,CAAA,iBAAA,GAAiB,iBAAjB","sourcesContent":["import * as React from 'react';\nimport { getNativeElementProps } from '@fluentui/react-utilities';\nimport type { ImageProps, ImageState } from './Image.types';\n\n/**\n * Given user props, returns state and render function for an Image.\n */\nexport const useImage_unstable = (props: ImageProps, ref: React.Ref<HTMLImageElement>): ImageState => {\n  const { bordered = false, fit = 'default', block = false, shape = 'square', shadow = false } = props;\n\n  const state: ImageState = {\n    bordered,\n    fit,\n    block,\n    shape,\n    shadow,\n    components: {\n      root: 'img',\n    },\n    root: getNativeElementProps('img', {\n      ref,\n      ...props,\n    }),\n  };\n\n  return state;\n};\n"],"sourceRoot":"../src/"}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@fluentui/react-image",
-  "version": "9.0.0-rc.6",
+  "version": "9.0.0-rc.9",
   "description": "Fluent UI React Image component.",
   "main": "lib-commonjs/index.js",
   "module": "lib/index.js",
-  "typings": "lib/index.d.ts",
+  "typings": "dist/index.d.ts",
   "sideEffects": false,
   "repository": {
     "type": "git",
@@ -21,20 +21,20 @@
     "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-image/src && yarn docs",
-    "storybook": "node ../../scripts/storybook/runner",
+    "build:local": "tsc -p ./tsconfig.lib.json --module esnext --emitDeclarationOnly && node ../../../scripts/typescript/normalize-import --output ./dist/packages/react-components/react-image/src && yarn docs",
+    "storybook": "node ../../../scripts/storybook/runner",
     "type-check": "tsc -b tsconfig.json"
   },
   "devDependencies": {
     "@fluentui/eslint-plugin": "*",
     "@fluentui/react-conformance": "*",
-    "@fluentui/react-conformance-griffel": "9.0.0-beta.4",
+    "@fluentui/react-conformance-griffel": "9.0.0-beta.6",
     "@fluentui/scripts": "^1.0.0"
   },
   "dependencies": {
-    "@griffel/react": "1.0.3",
-    "@fluentui/react-utilities": "9.0.0-rc.6",
-    "@fluentui/react-theme": "9.0.0-rc.5",
+    "@griffel/react": "1.0.5",
+    "@fluentui/react-utilities": "9.0.0-rc.9",
+    "@fluentui/react-theme": "9.0.0-rc.8",
     "tslib": "^2.1.0"
   },
   "peerDependencies": {

package/lib/Image.d.ts

@@ -1 +0,0 @@
-export * from './components/Image/index';

package/lib/components/Image/Image.d.ts

@@ -1,6 +0,0 @@
-import type { ImageProps } from './Image.types';
-import type { ForwardRefComponent } from '@fluentui/react-utilities';
-/**
- * The Image component ensures the consistent styling of images.
- */
-export declare const Image: ForwardRefComponent<ImageProps>;

package/lib/components/Image/Image.types.d.ts

@@ -1,30 +0,0 @@
-import type { ComponentState, ComponentProps, Slot } from '@fluentui/react-utilities';
-export declare type ImageSlots = {
-    root: Slot<'img'>;
-};
-declare type ImageCommons = {
-    /**
-     * An image can appear with rectangular border.
-     */
-    bordered?: boolean;
-    /**
-     * An image can set how it should be resized to fit its container.
-     */
-    fit?: 'none' | 'center' | 'contain' | 'cover';
-    /**
-     * An image can take up the width of its container.
-     */
-    block?: boolean;
-    /**
-     * An image can appear square, circular, or rounded.
-     * @defaultvalue square
-     */
-    shape?: 'square' | 'circular' | 'rounded';
-    /**
-     * An image can appear elevated with shadow.
-     */
-    shadow?: boolean;
-};
-export declare type ImageProps = ComponentProps<ImageSlots> & Partial<ImageCommons>;
-export declare type ImageState = ComponentState<ImageSlots> & ImageCommons;
-export {};

package/lib/components/Image/index.d.ts

@@ -1,5 +0,0 @@
-export * from './Image.types';
-export * from './Image';
-export * from './renderImage';
-export * from './useImage';
-export * from './useImageStyles';

package/lib/components/Image/renderImage.d.ts

@@ -1,6 +0,0 @@
-import { ImageState } from './Image.types';
-/**
- * Define the render function.
- * Given the state of an image, renders it.
- */
-export declare const renderImage_unstable: (state: ImageState) => JSX.Element;

package/lib/components/Image/useImage.d.ts

@@ -1,6 +0,0 @@
-import * as React from 'react';
-import type { ImageProps, ImageState } from './Image.types';
-/**
- * Given user props, returns state and render function for an Image.
- */
-export declare const useImage_unstable: (props: ImageProps, ref: React.Ref<HTMLImageElement>) => ImageState;

package/lib/components/Image/useImageStyles.d.ts

@@ -1,8 +0,0 @@
-import type { ImageSlots, ImageState } from './Image.types';
-import type { SlotClassNames } from '@fluentui/react-utilities';
-/**
- * @deprecated Use `imageClassNames.root` instead.
- */
-export declare const imageClassName = "fui-Image";
-export declare const imageClassNames: SlotClassNames<ImageSlots>;
-export declare const useImageStyles_unstable: (state: ImageState) => void;

package/lib/index.d.ts

@@ -1,2 +0,0 @@
-export { Image, imageClassName, imageClassNames, renderImage_unstable, useImageStyles_unstable, useImage_unstable, } from './Image';
-export type { ImageProps, ImageSlots, ImageState } from './Image';

package/lib-commonjs/Image.d.ts

@@ -1 +0,0 @@
-export * from './components/Image/index';

package/lib-commonjs/components/Image/Image.d.ts

@@ -1,6 +0,0 @@
-import type { ImageProps } from './Image.types';
-import type { ForwardRefComponent } from '@fluentui/react-utilities';
-/**
- * The Image component ensures the consistent styling of images.
- */
-export declare const Image: ForwardRefComponent<ImageProps>;

package/lib-commonjs/components/Image/Image.types.d.ts

@@ -1,30 +0,0 @@
-import type { ComponentState, ComponentProps, Slot } from '@fluentui/react-utilities';
-export declare type ImageSlots = {
-    root: Slot<'img'>;
-};
-declare type ImageCommons = {
-    /**
-     * An image can appear with rectangular border.
-     */
-    bordered?: boolean;
-    /**
-     * An image can set how it should be resized to fit its container.
-     */
-    fit?: 'none' | 'center' | 'contain' | 'cover';
-    /**
-     * An image can take up the width of its container.
-     */
-    block?: boolean;
-    /**
-     * An image can appear square, circular, or rounded.
-     * @defaultvalue square
-     */
-    shape?: 'square' | 'circular' | 'rounded';
-    /**
-     * An image can appear elevated with shadow.
-     */
-    shadow?: boolean;
-};
-export declare type ImageProps = ComponentProps<ImageSlots> & Partial<ImageCommons>;
-export declare type ImageState = ComponentState<ImageSlots> & ImageCommons;
-export {};

package/lib-commonjs/components/Image/index.d.ts

@@ -1,5 +0,0 @@
-export * from './Image.types';
-export * from './Image';
-export * from './renderImage';
-export * from './useImage';
-export * from './useImageStyles';

package/lib-commonjs/components/Image/renderImage.d.ts

@@ -1,6 +0,0 @@
-import { ImageState } from './Image.types';
-/**
- * Define the render function.
- * Given the state of an image, renders it.
- */
-export declare const renderImage_unstable: (state: ImageState) => JSX.Element;

package/lib-commonjs/components/Image/useImage.d.ts

@@ -1,6 +0,0 @@
-import * as React from 'react';
-import type { ImageProps, ImageState } from './Image.types';
-/**
- * Given user props, returns state and render function for an Image.
- */
-export declare const useImage_unstable: (props: ImageProps, ref: React.Ref<HTMLImageElement>) => ImageState;

package/lib-commonjs/components/Image/useImageStyles.d.ts

@@ -1,8 +0,0 @@
-import type { ImageSlots, ImageState } from './Image.types';
-import type { SlotClassNames } from '@fluentui/react-utilities';
-/**
- * @deprecated Use `imageClassNames.root` instead.
- */
-export declare const imageClassName = "fui-Image";
-export declare const imageClassNames: SlotClassNames<ImageSlots>;
-export declare const useImageStyles_unstable: (state: ImageState) => void;

package/lib-commonjs/index.d.ts

@@ -1,2 +0,0 @@
-export { Image, imageClassName, imageClassNames, renderImage_unstable, useImageStyles_unstable, useImage_unstable, } from './Image';
-export type { ImageProps, ImageSlots, ImageState } from './Image';