@fluentui-copilot/react-attachments 0.10.4 → 0.10.5

package/CHANGELOG.json

@@ -2,7 +2,34 @@
   "name": "@fluentui-copilot/react-attachments",
   "entries": [
     {
-      "date": "Wed, 18 Dec 2024 08:54:34 GMT",
+      "date": "Fri, 07 Feb 2025 02:01:25 GMT",
+      "tag": "@fluentui-copilot/react-attachments_v0.10.5",
+      "version": "0.10.5",
+      "comments": {
+        "none": [
+          {
+            "author": "jiangemma@microsoft.com",
+            "package": "@fluentui-copilot/react-attachments",
+            "commit": "5241649bf6e20e0d46fe7631923dfb7236bb9239",
+            "comment": "docs(react-attachments): Remove stories of deprecated components"
+          },
+          {
+            "author": "jiangemma@microsoft.com",
+            "package": "@fluentui-copilot/react-attachments",
+            "commit": "51290b6805d1f1823c3c3b471da9d717ff076352",
+            "comment": "docs: Add slot/prop descriptions for `Attachment`"
+          },
+          {
+            "author": "jiangemma@microsoft.com",
+            "package": "@fluentui-copilot/react-attachments",
+            "commit": "666bc197ec5646a5f10334bd6ced558c570fdeaf",
+            "comment": "docs: Add slot/prop descriptions for `AttachmentList`"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Wed, 18 Dec 2024 08:55:41 GMT",
       "tag": "@fluentui-copilot/react-attachments_v0.10.4",
       "version": "0.10.4",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,12 @@
 # Change Log - @fluentui-copilot/react-attachments
 
-This log was last generated on Wed, 18 Dec 2024 08:54:34 GMT and should not be manually modified.
+This log was last generated on Wed, 18 Dec 2024 08:55:41 GMT and should not be manually modified.
 
 <!-- Start content -->
 
 ## [0.10.4](https://github.com/microsoft/fluentai/tree/@fluentui-copilot/react-attachments_v0.10.4)
 
-Wed, 18 Dec 2024 08:54:34 GMT 
+Wed, 18 Dec 2024 08:55:41 GMT 
 [Compare changes](https://github.com/microsoft/fluentai/compare/@fluentui-copilot/react-attachments_v0.10.3..@fluentui-copilot/react-attachments_v0.10.4)
 
 ### Patches

package/dist/index.d.ts

@@ -47,7 +47,13 @@ declare type AttachmentListContextValues = {
  * AttachmentList Props
  */
 export declare type AttachmentListProps = ComponentProps<Partial<AttachmentListSlots>> & {
+    /**
+     * Callback fired when an attachment is dismissed.
+     */
     onAttachmentDismiss?: (e: React.MouseEvent<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement>, data: AttachmentDismissedData) => void;
+    /**
+     * Props that will be passed to the overflow menu.
+     */
     overflowMenuProps?: Omit<AttachmentOverflowMenuProps, 'children'>;
     /**
      * The maximum number of attachments to display before the overflow button is shown even if there is
@@ -62,6 +68,10 @@ export declare const AttachmentListProvider: Provider<AttachmentListContextValue
 
 export declare type AttachmentListSlots = {
     root: Slot<'div'>;
+    /**
+     * An AttachmentList has an overflow menu when `maxVisibleAttachments` is exceeded.
+     * Adding a custom button for the overflow menu is supported.
+     */
     overflowMenuButton: Slot<'span'>;
 };
 
@@ -156,6 +166,11 @@ export declare type AttachmentOverflowMenuState = MenuState & {
  * Attachment Props
  */
 export declare type AttachmentProps = ComponentProps<Partial<AttachmentSlots>> & {
+    /**
+     * Use this prop if an attachment has no text content.
+     *
+     * @default false
+     */
     imageOnly?: boolean;
     /**
      * An attachment supports different sizes.
@@ -167,11 +182,29 @@ export declare type AttachmentProps = ComponentProps<Partial<AttachmentSlots>> &
 
 export declare type AttachmentSlots = {
     root: NonNullable<Slot<'div'>>;
+    /**
+     * Attachments support a primary action.
+     */
     primaryAction: NonNullable<Slot<'button', 'span'>>;
+    /**
+     * Attachments have a dismiss button.
+     */
     dismissButton: NonNullable<Slot<'button'>>;
+    /**
+     * Attachments can include an image or other media.
+     */
     media?: Slot<'span'>;
+    /**
+     * The content of the attachment.
+     */
     content: NonNullable<Slot<'span'>>;
+    /**
+     * The icon that renders for the `dismissButton`.
+     */
     dismissIcon: NonNullable<Slot<'span'>>;
+    /**
+     * An attachment supports a progress bar, which can display the attachment's upload progress.
+     */
     progress?: Slot<typeof ProgressBar>;
 };
 

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

@@ -1 +1 @@
-{"version":3,"sources":["Attachment.types.ts"],"sourcesContent":["import type { ComponentProps, ComponentState, ProgressBar, Slot } from '@fluentui/react-components';\n\nexport type AttachmentSlots = {\n  root: NonNullable<Slot<'div'>>;\n  primaryAction: NonNullable<Slot<'button', 'span'>>;\n  dismissButton: NonNullable<Slot<'button'>>;\n  media?: Slot<'span'>;\n  content: NonNullable<Slot<'span'>>;\n  dismissIcon: NonNullable<Slot<'span'>>;\n  progress?: Slot<typeof ProgressBar>;\n};\n\n/**\n * Attachment Props\n */\nexport type AttachmentProps = ComponentProps<Partial<AttachmentSlots>> & {\n  imageOnly?: boolean;\n\n  /**\n   * An attachment supports different sizes.\n   *\n   * @default 'medium'\n   */\n  size?: 'small' | 'medium';\n};\n\n/**\n * State used in rendering Attachment\n */\nexport type AttachmentState = ComponentState<AttachmentSlots> &\n  Required<Pick<AttachmentProps, 'id' | 'size'>> &\n  Pick<AttachmentProps, 'imageOnly'> & {\n    isLoading: boolean;\n    shouldUseOverflow: boolean;\n  };\n"],"names":[],"rangeMappings":";;","mappings":"AA0BA;;CAEC,GACD,WAKI"}
+{"version":3,"sources":["Attachment.types.ts"],"sourcesContent":["import type { ComponentProps, ComponentState, ProgressBar, Slot } from '@fluentui/react-components';\n\nexport type AttachmentSlots = {\n  root: NonNullable<Slot<'div'>>;\n\n  /**\n   * Attachments support a primary action.\n   */\n  primaryAction: NonNullable<Slot<'button', 'span'>>;\n\n  /**\n   * Attachments have a dismiss button.\n   */\n  dismissButton: NonNullable<Slot<'button'>>;\n\n  /**\n   * Attachments can include an image or other media.\n   */\n  media?: Slot<'span'>;\n\n  /**\n   * The content of the attachment.\n   */\n  content: NonNullable<Slot<'span'>>;\n\n  /**\n   * The icon that renders for the `dismissButton`.\n   */\n  dismissIcon: NonNullable<Slot<'span'>>;\n\n  /**\n   * An attachment supports a progress bar, which can display the attachment's upload progress.\n   */\n  progress?: Slot<typeof ProgressBar>;\n};\n\n/**\n * Attachment Props\n */\nexport type AttachmentProps = ComponentProps<Partial<AttachmentSlots>> & {\n  /**\n   * Use this prop if an attachment has no text content.\n   *\n   * @default false\n   */\n  imageOnly?: boolean;\n\n  /**\n   * An attachment supports different sizes.\n   *\n   * @default 'medium'\n   */\n  size?: 'small' | 'medium';\n};\n\n/**\n * State used in rendering Attachment\n */\nexport type AttachmentState = ComponentState<AttachmentSlots> &\n  Required<Pick<AttachmentProps, 'id' | 'size'>> &\n  Pick<AttachmentProps, 'imageOnly'> & {\n    isLoading: boolean;\n    shouldUseOverflow: boolean;\n  };\n"],"names":[],"rangeMappings":";;","mappings":"AAuDA;;CAEC,GACD,WAKI"}

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

@@ -1 +1 @@
-{"version":3,"sources":["AttachmentList.types.ts"],"sourcesContent":["import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-components';\nimport type { AttachmentListContextValue } from '../../contexts/attachmentListContext';\nimport type { AttachmentProps } from '../Attachment';\nimport type { AttachmentOverflowMenuProps } from '../AttachmentOverflowMenu';\n\nexport type AttachmentListSlots = {\n  root: Slot<'div'>;\n  overflowMenuButton: Slot<'span'>;\n};\n\nexport type AttachmentDismissedData = {\n  content?: AttachmentProps['children'];\n  media?: AttachmentProps['media'];\n  id?: string;\n};\n\n/**\n * AttachmentList Props\n */\nexport type AttachmentListProps = ComponentProps<Partial<AttachmentListSlots>> & {\n  onAttachmentDismiss?: (\n    e: React.MouseEvent<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement>,\n    data: AttachmentDismissedData,\n  ) => void;\n  overflowMenuProps?: Omit<AttachmentOverflowMenuProps, 'children'>;\n  /**\n   * The maximum number of attachments to display before the overflow button is shown even if there is\n   * enough space available to show more.\n   * If not set, the overflow functionality will be disabled.\n   * @default undefined\n   */\n  maxVisibleAttachments?: number;\n};\n\n/**\n * State used in rendering AttachmentList\n */\nexport type AttachmentListState = ComponentState<AttachmentListSlots> &\n  Pick<AttachmentListProps, 'onAttachmentDismiss' | 'overflowMenuProps'> & {\n    attachments: AttachmentProps[];\n    shouldUseOverflow: boolean;\n  };\n\nexport type AttachmentListContextValues = {\n  attachmentList: AttachmentListContextValue;\n};\n"],"names":[],"rangeMappings":"","mappings":"AA2CA,WAEE"}
+{"version":3,"sources":["AttachmentList.types.ts"],"sourcesContent":["import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-components';\nimport type { AttachmentListContextValue } from '../../contexts/attachmentListContext';\nimport type { AttachmentProps } from '../Attachment';\nimport type { AttachmentOverflowMenuProps } from '../AttachmentOverflowMenu';\n\nexport type AttachmentListSlots = {\n  root: Slot<'div'>;\n\n  /**\n   * An AttachmentList has an overflow menu when `maxVisibleAttachments` is exceeded.\n   * Adding a custom button for the overflow menu is supported.\n   */\n  overflowMenuButton: Slot<'span'>;\n};\n\nexport type AttachmentDismissedData = {\n  content?: AttachmentProps['children'];\n  media?: AttachmentProps['media'];\n  id?: string;\n};\n\n/**\n * AttachmentList Props\n */\nexport type AttachmentListProps = ComponentProps<Partial<AttachmentListSlots>> & {\n  /**\n   * Callback fired when an attachment is dismissed.\n   */\n  onAttachmentDismiss?: (\n    e: React.MouseEvent<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement>,\n    data: AttachmentDismissedData,\n  ) => void;\n\n  /**\n   * Props that will be passed to the overflow menu.\n   */\n  overflowMenuProps?: Omit<AttachmentOverflowMenuProps, 'children'>;\n\n  /**\n   * The maximum number of attachments to display before the overflow button is shown even if there is\n   * enough space available to show more.\n   * If not set, the overflow functionality will be disabled.\n   * @default undefined\n   */\n  maxVisibleAttachments?: number;\n};\n\n/**\n * State used in rendering AttachmentList\n */\nexport type AttachmentListState = ComponentState<AttachmentListSlots> &\n  Pick<AttachmentListProps, 'onAttachmentDismiss' | 'overflowMenuProps'> & {\n    attachments: AttachmentProps[];\n    shouldUseOverflow: boolean;\n  };\n\nexport type AttachmentListContextValues = {\n  attachmentList: AttachmentListContextValue;\n};\n"],"names":[],"rangeMappings":"","mappings":"AAwDA,WAEE"}

package/lib-commonjs/components/Attachment/Attachment.types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["Attachment.types.ts"],"sourcesContent":["import type { ComponentProps, ComponentState, ProgressBar, Slot } from '@fluentui/react-components';\n\nexport type AttachmentSlots = {\n  root: NonNullable<Slot<'div'>>;\n  primaryAction: NonNullable<Slot<'button', 'span'>>;\n  dismissButton: NonNullable<Slot<'button'>>;\n  media?: Slot<'span'>;\n  content: NonNullable<Slot<'span'>>;\n  dismissIcon: NonNullable<Slot<'span'>>;\n  progress?: Slot<typeof ProgressBar>;\n};\n\n/**\n * Attachment Props\n */\nexport type AttachmentProps = ComponentProps<Partial<AttachmentSlots>> & {\n  imageOnly?: boolean;\n\n  /**\n   * An attachment supports different sizes.\n   *\n   * @default 'medium'\n   */\n  size?: 'small' | 'medium';\n};\n\n/**\n * State used in rendering Attachment\n */\nexport type AttachmentState = ComponentState<AttachmentSlots> &\n  Required<Pick<AttachmentProps, 'id' | 'size'>> &\n  Pick<AttachmentProps, 'imageOnly'> & {\n    isLoading: boolean;\n    shouldUseOverflow: boolean;\n  };\n"],"names":[],"rangeMappings":";;","mappings":"AA0BA;;CAEC"}
+{"version":3,"sources":["Attachment.types.ts"],"sourcesContent":["import type { ComponentProps, ComponentState, ProgressBar, Slot } from '@fluentui/react-components';\n\nexport type AttachmentSlots = {\n  root: NonNullable<Slot<'div'>>;\n\n  /**\n   * Attachments support a primary action.\n   */\n  primaryAction: NonNullable<Slot<'button', 'span'>>;\n\n  /**\n   * Attachments have a dismiss button.\n   */\n  dismissButton: NonNullable<Slot<'button'>>;\n\n  /**\n   * Attachments can include an image or other media.\n   */\n  media?: Slot<'span'>;\n\n  /**\n   * The content of the attachment.\n   */\n  content: NonNullable<Slot<'span'>>;\n\n  /**\n   * The icon that renders for the `dismissButton`.\n   */\n  dismissIcon: NonNullable<Slot<'span'>>;\n\n  /**\n   * An attachment supports a progress bar, which can display the attachment's upload progress.\n   */\n  progress?: Slot<typeof ProgressBar>;\n};\n\n/**\n * Attachment Props\n */\nexport type AttachmentProps = ComponentProps<Partial<AttachmentSlots>> & {\n  /**\n   * Use this prop if an attachment has no text content.\n   *\n   * @default false\n   */\n  imageOnly?: boolean;\n\n  /**\n   * An attachment supports different sizes.\n   *\n   * @default 'medium'\n   */\n  size?: 'small' | 'medium';\n};\n\n/**\n * State used in rendering Attachment\n */\nexport type AttachmentState = ComponentState<AttachmentSlots> &\n  Required<Pick<AttachmentProps, 'id' | 'size'>> &\n  Pick<AttachmentProps, 'imageOnly'> & {\n    isLoading: boolean;\n    shouldUseOverflow: boolean;\n  };\n"],"names":[],"rangeMappings":";;","mappings":"AAuDA;;CAEC"}

package/lib-commonjs/components/AttachmentList/AttachmentList.types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["AttachmentList.types.ts"],"sourcesContent":["import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-components';\nimport type { AttachmentListContextValue } from '../../contexts/attachmentListContext';\nimport type { AttachmentProps } from '../Attachment';\nimport type { AttachmentOverflowMenuProps } from '../AttachmentOverflowMenu';\n\nexport type AttachmentListSlots = {\n  root: Slot<'div'>;\n  overflowMenuButton: Slot<'span'>;\n};\n\nexport type AttachmentDismissedData = {\n  content?: AttachmentProps['children'];\n  media?: AttachmentProps['media'];\n  id?: string;\n};\n\n/**\n * AttachmentList Props\n */\nexport type AttachmentListProps = ComponentProps<Partial<AttachmentListSlots>> & {\n  onAttachmentDismiss?: (\n    e: React.MouseEvent<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement>,\n    data: AttachmentDismissedData,\n  ) => void;\n  overflowMenuProps?: Omit<AttachmentOverflowMenuProps, 'children'>;\n  /**\n   * The maximum number of attachments to display before the overflow button is shown even if there is\n   * enough space available to show more.\n   * If not set, the overflow functionality will be disabled.\n   * @default undefined\n   */\n  maxVisibleAttachments?: number;\n};\n\n/**\n * State used in rendering AttachmentList\n */\nexport type AttachmentListState = ComponentState<AttachmentListSlots> &\n  Pick<AttachmentListProps, 'onAttachmentDismiss' | 'overflowMenuProps'> & {\n    attachments: AttachmentProps[];\n    shouldUseOverflow: boolean;\n  };\n\nexport type AttachmentListContextValues = {\n  attachmentList: AttachmentListContextValue;\n};\n"],"names":[],"rangeMappings":"","mappings":""}
+{"version":3,"sources":["AttachmentList.types.ts"],"sourcesContent":["import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-components';\nimport type { AttachmentListContextValue } from '../../contexts/attachmentListContext';\nimport type { AttachmentProps } from '../Attachment';\nimport type { AttachmentOverflowMenuProps } from '../AttachmentOverflowMenu';\n\nexport type AttachmentListSlots = {\n  root: Slot<'div'>;\n\n  /**\n   * An AttachmentList has an overflow menu when `maxVisibleAttachments` is exceeded.\n   * Adding a custom button for the overflow menu is supported.\n   */\n  overflowMenuButton: Slot<'span'>;\n};\n\nexport type AttachmentDismissedData = {\n  content?: AttachmentProps['children'];\n  media?: AttachmentProps['media'];\n  id?: string;\n};\n\n/**\n * AttachmentList Props\n */\nexport type AttachmentListProps = ComponentProps<Partial<AttachmentListSlots>> & {\n  /**\n   * Callback fired when an attachment is dismissed.\n   */\n  onAttachmentDismiss?: (\n    e: React.MouseEvent<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement>,\n    data: AttachmentDismissedData,\n  ) => void;\n\n  /**\n   * Props that will be passed to the overflow menu.\n   */\n  overflowMenuProps?: Omit<AttachmentOverflowMenuProps, 'children'>;\n\n  /**\n   * The maximum number of attachments to display before the overflow button is shown even if there is\n   * enough space available to show more.\n   * If not set, the overflow functionality will be disabled.\n   * @default undefined\n   */\n  maxVisibleAttachments?: number;\n};\n\n/**\n * State used in rendering AttachmentList\n */\nexport type AttachmentListState = ComponentState<AttachmentListSlots> &\n  Pick<AttachmentListProps, 'onAttachmentDismiss' | 'overflowMenuProps'> & {\n    attachments: AttachmentProps[];\n    shouldUseOverflow: boolean;\n  };\n\nexport type AttachmentListContextValues = {\n  attachmentList: AttachmentListContextValue;\n};\n"],"names":[],"rangeMappings":"","mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluentui-copilot/react-attachments",
-  "version": "0.10.4",
+  "version": "0.10.5",
   "description": "A set of components related to attaching files in Copilot experiences.",
   "main": "lib-commonjs/index.js",
   "module": "lib/index.js",
@@ -13,7 +13,7 @@
   "license": "MIT",
   "dependencies": {
     "@fluentui-copilot/react-provider": "^0.9.3",
-    "@fluentui-copilot/react-utilities": "^0.0.4",
+    "@fluentui-copilot/react-utilities": "^0.0.5",
     "@fluentui-copilot/tokens": "^0.3.3",
     "@swc/helpers": "^0.5.1"
   },