@fluentui-copilot/react-reference 0.11.4 → 0.12.1

package/CHANGELOG.json

@@ -2,7 +2,85 @@
   "name": "@fluentui-copilot/react-reference",
   "entries": [
     {
-      "date": "Thu, 13 Jun 2024 21:00:14 GMT",
+      "date": "Tue, 23 Jul 2024 00:55:16 GMT",
+      "tag": "@fluentui-copilot/react-reference_v0.12.1",
+      "version": "0.12.1",
+      "comments": {
+        "none": [
+          {
+            "author": "humbertomakotomorimoto@gmail.com",
+            "package": "@fluentui-copilot/react-reference",
+            "commit": "bf9c5189f3c0f139c48a3b0356aef3fccdec515d",
+            "comment": "chore: Writing tests for `generateReferenceCitationPreview` function and fixing issue with `ResizeObserver` in `ReferenceListV2` tests."
+          },
+          {
+            "author": "Humberto.Morimoto@microsoft.com",
+            "package": "@fluentui-copilot/react-reference",
+            "commit": "cc329eba8d66002a215a35f16c1622a2cadc0355",
+            "comment": "docs(react-reference): Removing ReferenceOverflowButton stories in favor of adding API as subcomponent to table in ReferenceList docs."
+          },
+          {
+            "author": "jiangemma@microsoft.com",
+            "package": "@fluentui-copilot/react-reference",
+            "commit": "04ba6d570c641c2b406a94a2ead8094daaa6c92a",
+            "comment": "docs: Combine Citation and ReferenceV2 stories."
+          }
+        ],
+        "patch": [
+          {
+            "author": "Humberto.Morimoto@microsoft.com",
+            "package": "@fluentui-copilot/react-reference",
+            "commit": "eccb618e00c9a2bcec1111b302140ba1f51a64ad",
+            "comment": "feat: Deduplicating overflow code by using useOverflowMaxVisibleItems shared hook instead."
+          },
+          {
+            "author": "jiangemma@microsoft.com",
+            "package": "@fluentui-copilot/react-reference",
+            "commit": "2ab6acda372c69b7fdc733d7f402c64a66f98a1a",
+            "comment": "Bump Fluent UI version to latest"
+          },
+          {
+            "author": "Humberto.Morimoto@microsoft.com",
+            "package": "@fluentui-copilot/react-reference",
+            "commit": "0fec4afd80ad76eba5b423b9df8e48e1ca5b22ef",
+            "comment": "feat(react-reference): Creating generateReferenceCitationPreview function that can generate a Citation <-> Reference pair without being restricted by the rules of hooks."
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 20 Jun 2024 23:05:53 GMT",
+      "tag": "@fluentui-copilot/react-reference_v0.12.0",
+      "version": "0.12.0",
+      "comments": {
+        "none": [
+          {
+            "author": "tristan.watanabe@gmail.com",
+            "package": "@fluentui-copilot/react-reference",
+            "commit": "b8a46e43b66fa17ed3cbb98a57171f9805ca5801",
+            "comment": "fix: failing e2e tests after playwright/test dependency update to v1.44.0."
+          }
+        ],
+        "minor": [
+          {
+            "author": "Humberto.Morimoto@microsoft.com",
+            "package": "@fluentui-copilot/react-reference",
+            "commit": "fc6c01300d29e17aa4bd56305a0f4fd2d9f7b94c",
+            "comment": "chore: Deprecating Reference v1 pattern, and consolidating Citation, Reference v1 and Reference v2 docs."
+          }
+        ],
+        "patch": [
+          {
+            "author": "humbertomakotomorimoto@gmail.com",
+            "package": "@fluentui-copilot/react-reference",
+            "commit": "8556966a4bc720f393d1c00b6befb857cc757877",
+            "comment": "fix: Making some fit-and-finish styling changes to better match design specs."
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 13 Jun 2024 21:00:45 GMT",
       "tag": "@fluentui-copilot/react-reference_v0.11.4",
       "version": "0.11.4",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,36 @@
 # Change Log - @fluentui-copilot/react-reference
 
-This log was last generated on Thu, 13 Jun 2024 21:00:14 GMT and should not be manually modified.
+This log was last generated on Tue, 23 Jul 2024 00:55:16 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## [0.12.1](https://github.com/microsoft/fluentai/tree/@fluentui-copilot/react-reference_v0.12.1)
+
+Tue, 23 Jul 2024 00:55:16 GMT 
+[Compare changes](https://github.com/microsoft/fluentai/compare/@fluentui-copilot/react-reference_v0.12.0..@fluentui-copilot/react-reference_v0.12.1)
+
+### Patches
+
+- feat: Deduplicating overflow code by using useOverflowMaxVisibleItems shared hook instead. ([PR #1762](https://github.com/microsoft/fluentai/pull/1762) by Humberto.Morimoto@microsoft.com)
+- Bump Fluent UI version to latest ([PR #1805](https://github.com/microsoft/fluentai/pull/1805) by jiangemma@microsoft.com)
+- feat(react-reference): Creating generateReferenceCitationPreview function that can generate a Citation <-> Reference pair without being restricted by the rules of hooks. ([PR #1782](https://github.com/microsoft/fluentai/pull/1782) by Humberto.Morimoto@microsoft.com)
+
+## [0.12.0](https://github.com/microsoft/fluentai/tree/@fluentui-copilot/react-reference_v0.12.0)
+
+Thu, 20 Jun 2024 23:05:53 GMT 
+[Compare changes](https://github.com/microsoft/fluentai/compare/@fluentui-copilot/react-reference_v0.11.4..@fluentui-copilot/react-reference_v0.12.0)
+
+### Minor changes
+
+- chore: Deprecating Reference v1 pattern, and consolidating Citation, Reference v1 and Reference v2 docs. ([PR #1731](https://github.com/microsoft/fluentai/pull/1731) by Humberto.Morimoto@microsoft.com)
+
+### Patches
+
+- fix: Making some fit-and-finish styling changes to better match design specs. ([PR #1748](https://github.com/microsoft/fluentai/pull/1748) by humbertomakotomorimoto@gmail.com)
+
 ## [0.11.4](https://github.com/microsoft/fluentai/tree/@fluentui-copilot/react-reference_v0.11.4)
 
-Thu, 13 Jun 2024 21:00:14 GMT 
+Thu, 13 Jun 2024 21:00:45 GMT 
 [Compare changes](https://github.com/microsoft/fluentai/compare/@fluentui-copilot/react-reference_v0.11.3..@fluentui-copilot/react-reference_v0.11.4)
 
 ### Patches

package/dist/index.d.ts

@@ -54,6 +54,20 @@ declare type CopilotMode = {
     mode?: 'canvas' | 'sidecar';
 };
 
+/**
+ * Function to generate a Citation - Reference pair with correctly wired props.
+ * Both the Citation and the Reference act as trigger components to Previews that are also correctly wired by the function.
+ * Props can either be passed in to the function or applied directly to the generated components in JSX.
+ *
+ * A `useReferenceCitationPreview` hook exists that calls this function and memoizes its return value based on the props.
+ * You should use the hook when the props used to generate the Citation - Reference pair can change dynamically.
+ * If they are static, or in case you wanted to generate multiple pairs within a cycle, you should call
+ * `generateReferenceCitationPreview` directly.
+ *
+ * @returns A Citation - Reference pair with correctly wired props.
+ */
+export declare const generateReferenceCitationPreview: ReferenceCitationPreviewGenerator;
+
 /**
  * A "packaged Citation". A packaged Citation is a `Citation` that is
  * pre-packaged with props set by the `useReferenceCitation` hook.
@@ -141,7 +155,7 @@ declare type PreviewMetadataSlots = {
 /**
  * Preview Props
  */
-declare type PreviewProps = PopoverProps;
+declare type PreviewProps = Omit<PopoverProps, 'mouseLeaveDelay' | 'openOnHover'>;
 
 declare const PreviewSurface: ForwardRefComponent<PreviewSurfaceProps>;
 
@@ -152,6 +166,7 @@ declare type PreviewSurfaceProps = ComponentProps<PreviewSurfaceSlots> & Popover
 
 declare type PreviewSurfaceSlots = PopoverSurfaceSlots & {};
 
+/** deprecated Use ReferenceV2 component, hooks and types instead. */
 export declare const Reference: ForwardRefComponent<ReferenceProps>;
 
 /**
@@ -170,8 +185,28 @@ export declare type ReferenceCitationData = {
     sensitivityLabelProps?: SensitivityLabelProps;
 };
 
+export declare type ReferenceCitationPreviewGenerator = (props: ReferenceCitationPreviewGeneratorProps) => {
+    Citation: PackagedCitationV2;
+    Reference: PackagedReferenceV2;
+};
+
+export declare type ReferenceCitationPreviewGeneratorProps = {
+    citationPreviewProps?: PreviewProps;
+    citationPreviewSurfaceProps?: PreviewSurfaceProps;
+    citationProps?: CitationProps;
+    index: number;
+    previewContentProps?: PackagedPreviewContentV2Props;
+    previewHeaderProps?: PreviewHeaderProps;
+    referencePreviewProps?: PreviewProps;
+    referencePreviewSurfaceProps?: PreviewSurfaceProps;
+    referenceProps?: ReferenceV2Props;
+    sensitivityLabelProps?: SensitivityLabelProps;
+};
+
+/** deprecated Use ReferenceV2 component, hooks and types instead. */
 export declare const referenceClassNames: SlotClassNames<ReferenceSlots>;
 
+/** deprecated The ReferenceGroup pattern is deprecated and will be removed in a future release. */
 export declare const ReferenceGroupToggle: ForwardRefComponent<ReferenceGroupToggleProps>;
 
 export declare const referenceGroupToggleClassNames: SlotClassNames<ReferenceGroupToggleSlots>;
@@ -193,8 +228,10 @@ export declare type ReferenceGroupToggleSlots = {
  */
 export declare type ReferenceGroupToggleState = ComponentState<ReferenceGroupToggleSlots> & Required<Pick<ReferenceGroupToggleProps, 'isOpen' | 'mode'>>;
 
+/** deprecated Use ReferenceListV2 component, hooks and types instead. */
 export declare const ReferenceList: ForwardRefComponent<ReferenceListProps>;
 
+/** deprecated Use ReferenceListV2 component, hooks and types instead. */
 export declare const referenceListClassNames: SlotClassNames<ReferenceListSlots>;
 
 export declare const ReferenceListContext: Context<ReferenceListContextValue>;
@@ -206,11 +243,10 @@ export declare const ReferenceListContextProvider: Provider<ReferenceListContext
  */
 export declare type ReferenceListContextValue = Pick<ReferenceListV2State, 'areReferencesExpanded' | 'maxVisibleReferences' | 'overflowButtonTriggeredViaKeyboard' | 'referenceListRef' | 'shouldUseOverflow' | 'totalReferencesCount'>;
 
-/**
- * ReferenceList Props
- */
+/** deprecated Use ReferenceListV2 component, hooks and types instead. */
 export declare type ReferenceListProps = ComponentProps<ReferenceListSlots>;
 
+/** deprecated Use ReferenceListV2 component, hooks and types instead. */
 export declare type ReferenceListSlots = {
     /**
      * The root slot.
@@ -218,9 +254,7 @@ export declare type ReferenceListSlots = {
     root: Slot<'ol'>;
 };
 
-/**
- * State used in rendering ReferenceList
- */
+/** deprecated Use ReferenceListV2 component, hooks and types instead. */
 export declare type ReferenceListState = ComponentState<ReferenceListSlots>;
 
 export declare const ReferenceListV2: ForwardRefComponent<ReferenceListV2Props>;
@@ -286,9 +320,7 @@ export declare type ReferenceOverflowButtonState = ComponentState<ReferenceOverf
     shouldRenderOverflowButton: boolean;
 };
 
-/**
- * Reference Props
- */
+/** deprecated Use ReferenceV2 component, hooks and types instead. */
 export declare type ReferenceProps = ComponentProps<Partial<ReferenceSlots>> & CopilotMode & {
     /**
      * Numeric index associated with `Citation`.
@@ -312,6 +344,7 @@ export declare type ReferenceProps = ComponentProps<Partial<ReferenceSlots>> & C
     layout?: 'inline' | 'popover';
 };
 
+/** deprecated Use ReferenceV2 component, hooks and types instead. */
 export declare type ReferenceSlots = {
     /**
      * The root slot.
@@ -367,9 +400,7 @@ export declare type ReferenceSlots = {
     detailsButton: Slot<typeof Button>;
 };
 
-/**
- * State used in rendering Reference
- */
+/** deprecated Use ReferenceV2 component, hooks and types instead. */
 export declare type ReferenceState = ComponentState<ReferenceSlots> & Required<Pick<ReferenceProps, 'mode' | 'layout' | 'index'>> & {
     /**
      * State used to renderer the `Reference` in an expanded state.
@@ -407,9 +438,7 @@ export declare type ReferenceV2State = ComponentState<ReferenceV2Slots> & Requir
  */
 export declare const renderCitation_unstable: (state: CitationState) => JSX.Element;
 
-/**
- * Render the final JSX of Reference
- */
+/** deprecated Use ReferenceV2 component, hooks and types instead. */
 export declare const renderReference_unstable: (state: ReferenceState) => JSX.Element;
 
 /**
@@ -417,9 +446,7 @@ export declare const renderReference_unstable: (state: ReferenceState) => JSX.El
  */
 export declare const renderReferenceGroupToggle_unstable: (state: ReferenceGroupToggleState) => JSX.Element;
 
-/**
- * Render the final JSX of ReferenceList
- */
+/** deprecated Use ReferenceListV2 component, hooks and types instead. */
 export declare const renderReferenceList_unstable: (state: ReferenceListState) => JSX.Element;
 
 /**
@@ -454,6 +481,10 @@ declare const SensitivityTooltip: ForwardRefComponent<SensitivityTooltipProps>;
  */
 declare type SensitivityTooltipProps = ComponentProps<SensitivityTooltipSlots> & {
     positioning?: PositioningShorthand;
+    /**
+     * Prop to display a backplate behind the tooltip
+     */
+    withBackplate?: boolean;
 };
 
 declare type SensitivityTooltipSlots = {
@@ -488,6 +519,8 @@ export declare const useCitationStyles_unstable: (state: CitationState) => Citat
  *
  * @param props - props from this instance of Reference
  * @param ref - reference to root HTMLElement of Reference
+ *
+ * deprecated Use ReferenceV2 component, hooks and types instead.
  */
 export declare const useReference_unstable: (props: ReferenceProps, ref: React_2.Ref<HTMLDivElement>) => ReferenceState;
 
@@ -505,25 +538,23 @@ export declare type UseReferenceCitationPreview = (data: ReferenceCitationData)
  */
 export declare const useReferenceCitationPreview: UseReferenceCitationPreview;
 
-export declare type UseReferenceCitationPreviewV2 = (props: UseReferenceCitationPreviewV2Props) => {
-    Citation: PackagedCitationV2;
-    Reference: PackagedReferenceV2;
-};
+export declare type UseReferenceCitationPreviewV2 = ReferenceCitationPreviewGenerator;
 
+/**
+ * Hook to generate a Citation - Reference pair with correctly wired props.
+ * Both the Citation and the Reference act as trigger components to Previews that are also correctly wired by the hook.
+ * Props can either be passed in to the hook or applied directly to the generated components in JSX.
+ *
+ * This hook internally calls the `generateReferenceCitationPreview` function and memoizes its return value based on the props.
+ * You should only use this hook when the props used to generate the Citation - Reference pair can change dynamically.
+ * If they are static, or in case you wanted to generate multiple pairs within a cycle, you should call
+ * `generateReferenceCitationPreview` directly.
+ *
+ * @returns A Citation - Reference pair with correctly wired props.
+ */
 export declare const useReferenceCitationPreviewV2: UseReferenceCitationPreviewV2;
 
-export declare type UseReferenceCitationPreviewV2Props = {
-    citationPreviewProps?: PreviewProps;
-    citationPreviewSurfaceProps?: PreviewSurfaceProps;
-    citationProps?: CitationProps;
-    index: number;
-    previewContentProps?: PackagedPreviewContentV2Props;
-    previewHeaderProps?: PreviewHeaderProps;
-    referencePreviewProps?: PreviewProps;
-    referencePreviewSurfaceProps?: PreviewSurfaceProps;
-    referenceProps?: ReferenceV2Props;
-    sensitivityLabelProps?: SensitivityLabelProps;
-};
+export declare type UseReferenceCitationPreviewV2Props = ReferenceCitationPreviewGeneratorProps;
 
 export declare type UseReferenceGroup = (props: UseReferenceGroupProps) => {
     referenceGroupToggleProps: ReferenceGroupToggleProps;
@@ -567,6 +598,8 @@ export declare const useReferenceGroupToggleStyles_unstable: (state: ReferenceGr
  *
  * @param props - props from this instance of ReferenceList
  * @param ref - reference to root HTMLElement of ReferenceList
+ *
+ * deprecated Use ReferenceListV2 component, hooks and types instead.
  */
 export declare const useReferenceList_unstable: (props: ReferenceListProps, ref: React_2.Ref<HTMLOListElement>) => ReferenceListState;
 
@@ -574,14 +607,11 @@ export declare const useReferenceListContext_unstable: <T>(selector: ContextSele
 
 /**
  * Apply styling to the ReferenceList slots based on the state
+ *
+ * deprecated Use ReferenceListV2 component, hooks and types instead.
  */
 export declare const useReferenceListStyles_unstable: (state: ReferenceListState) => ReferenceListState;
 
-/**
- * Apply styling to the ReferenceList slots based on the state
- */
-export declare const useReferenceListStylesV2_unstable: (state: ReferenceListV2State) => ReferenceListV2State;
-
 /**
  * Create the state required to render ReferenceList.
  *
@@ -593,6 +623,11 @@ export declare const useReferenceListStylesV2_unstable: (state: ReferenceListV2S
  */
 export declare const useReferenceListV2_unstable: (props: ReferenceListV2Props, ref: React_2.Ref<HTMLDivElement>) => ReferenceListV2State;
 
+/**
+ * Apply styling to the ReferenceList slots based on the state
+ */
+export declare const useReferenceListV2Styles_unstable: (state: ReferenceListV2State) => ReferenceListV2State;
+
 /**
  * Create the state required to render ReferenceOverflowButton.
  *
@@ -611,14 +646,11 @@ export declare const useReferenceOverflowButtonStyles_unstable: (state: Referenc
 
 /**
  * Apply styling to the Reference slots based on the state
+ *
+ * deprecated Use ReferenceV2 component, hooks and types instead.
  */
 export declare const useReferenceStyles_unstable: (state: ReferenceState) => ReferenceState;
 
-/**
- * Apply styling to the Reference slots based on the state
- */
-export declare const useReferenceStylesV2_unstable: (state: ReferenceV2State) => ReferenceV2State;
-
 /**
  * Create the state required to render Reference.
  *
@@ -630,4 +662,9 @@ export declare const useReferenceStylesV2_unstable: (state: ReferenceV2State) =>
  */
 export declare const useReferenceV2_unstable: (props: ReferenceV2Props, ref: React_2.Ref<HTMLButtonElement | HTMLAnchorElement>) => ReferenceV2State;
 
+/**
+ * Apply styling to the Reference slots based on the state
+ */
+export declare const useReferenceV2Styles_unstable: (state: ReferenceV2State) => ReferenceV2State;
+
 export { }

package/lib/components/Reference/Reference.js

@@ -3,7 +3,7 @@ import { useReference_unstable } from './useReference';
 import { renderReference_unstable } from './renderReference';
 import { useReferenceStyles_unstable } from './useReferenceStyles.styles';
 import { useCustomStyleHook } from '@fluentui-copilot/react-provider';
-// Reference component - TODO: add more docs
+/** deprecated Use ReferenceV2 component, hooks and types instead. */
 export const Reference = /*#__PURE__*/React.forwardRef((props, ref) => {
   const state = useReference_unstable(props, ref);
   useReferenceStyles_unstable(state);

package/lib/components/Reference/Reference.js.map

@@ -1 +1 @@
-{"version":3,"sources":["Reference.tsx"],"sourcesContent":["import * as React from 'react';\nimport { useReference_unstable } from './useReference';\nimport { renderReference_unstable } from './renderReference';\nimport { useReferenceStyles_unstable } from './useReferenceStyles.styles';\nimport type { ReferenceProps } from './Reference.types';\nimport type { ForwardRefComponent } from '@fluentui/react-components';\nimport { useCustomStyleHook } from '@fluentui-copilot/react-provider';\n\n// Reference component - TODO: add more docs\nexport const Reference: ForwardRefComponent<ReferenceProps> = React.forwardRef((props, ref) => {\n  const state = useReference_unstable(props, ref);\n\n  useReferenceStyles_unstable(state);\n  useCustomStyleHook('useReferenceStyles')(state);\n\n  return renderReference_unstable(state);\n});\n\nReference.displayName = 'Reference';\n"],"names":["React","useReference_unstable","renderReference_unstable","useReferenceStyles_unstable","useCustomStyleHook","Reference","forwardRef","props","ref","state","displayName"],"rangeMappings":";;;;;;;;;;;;","mappings":"AAAA,YAAYA,WAAW,QAAQ;AAC/B,SAASC,qBAAqB,QAAQ,iBAAiB;AACvD,SAASC,wBAAwB,QAAQ,oBAAoB;AAC7D,SAASC,2BAA2B,QAAQ,8BAA8B;AAG1E,SAASC,kBAAkB,QAAQ,mCAAmC;AAEtE,4CAA4C;AAC5C,OAAO,MAAMC,0BAAiDL,MAAMM,UAAU,CAAC,CAACC,OAAOC;IACrF,MAAMC,QAAQR,sBAAsBM,OAAOC;IAE3CL,4BAA4BM;IAC5BL,mBAAmB,sBAAsBK;IAEzC,OAAOP,yBAAyBO;AAClC,GAAG;AAEHJ,UAAUK,WAAW,GAAG"}
+{"version":3,"sources":["Reference.tsx"],"sourcesContent":["import * as React from 'react';\nimport { useReference_unstable } from './useReference';\nimport { renderReference_unstable } from './renderReference';\nimport { useReferenceStyles_unstable } from './useReferenceStyles.styles';\nimport type { ReferenceProps } from './Reference.types';\nimport type { ForwardRefComponent } from '@fluentui/react-components';\nimport { useCustomStyleHook } from '@fluentui-copilot/react-provider';\n\n/** deprecated Use ReferenceV2 component, hooks and types instead. */\nexport const Reference: ForwardRefComponent<ReferenceProps> = React.forwardRef((props, ref) => {\n  const state = useReference_unstable(props, ref);\n\n  useReferenceStyles_unstable(state);\n  useCustomStyleHook('useReferenceStyles')(state);\n\n  return renderReference_unstable(state);\n});\n\nReference.displayName = 'Reference';\n"],"names":["React","useReference_unstable","renderReference_unstable","useReferenceStyles_unstable","useCustomStyleHook","Reference","forwardRef","props","ref","state","displayName"],"rangeMappings":";;;;;;;;;;;","mappings":"AAAA,YAAYA,WAAW,QAAQ;AAC/B,SAASC,qBAAqB,QAAQ,iBAAiB;AACvD,SAASC,wBAAwB,QAAQ,oBAAoB;AAC7D,SAASC,2BAA2B,QAAQ,8BAA8B;AAG1E,SAASC,kBAAkB,QAAQ,mCAAmC;AAEtE,mEAAmE,GACnE,OAAO,MAAMC,0BAAiDL,MAAMM,UAAU,CAAC,CAACC,OAAOC;IACrF,MAAMC,QAAQR,sBAAsBM,OAAOC;IAE3CL,4BAA4BM;IAC5BL,mBAAmB,sBAAsBK;IAEzC,OAAOP,yBAAyBO;AAClC,GAAG;AAEHJ,UAAUK,WAAW,GAAG"}

package/lib/components/Reference/Reference.types.js

@@ -1,4 +1,2 @@
-/**
- * State used in rendering Reference
- */export {};
+/** deprecated Use ReferenceV2 component, hooks and types instead. */export {};
 //# sourceMappingURL=Reference.types.js.map

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

@@ -1 +1 @@
-{"version":3,"sources":["Reference.types.ts"],"sourcesContent":["import type { CopilotMode } from '@fluentui-copilot/react-provider';\nimport type { Button, ComponentProps, ComponentState, Slot } from '@fluentui/react-components';\n\nexport type ReferenceSlots = {\n  /**\n   * The root slot.\n   */\n  root: NonNullable<Slot<'div'>>;\n\n  /**\n   * Citation slot. Displays a `Citation`. Set the `null` to hide the citation.\n   */\n  citation: Slot<'div'>;\n\n  /**\n   * Media slot. Used to display Avatars, Icons, etc.\n   */\n  media: Slot<'div'>;\n\n  /**\n   * Actions slot.\n   */\n  actions: Slot<'div'>;\n\n  /**\n   * Label slot. Primary description of the reference.\n   */\n  label: NonNullable<Slot<'div'>>;\n\n  /**\n   * Sensitivity slot. Used to display a `SensitivityLabel`.\n   */\n  sensitivity: Slot<'span'>;\n\n  /**\n   * Metadata slot. Container for `primaryText`, `secondaryText`, `tertiaryText` and `icon`.\n   */\n  metadata: NonNullable<Slot<'div'>>;\n\n  /**\n   * Primary text slot. First displayed metadata text.\n   */\n  primaryText: Slot<'span'>;\n\n  /**\n   * Secondary text slot. Second displayed metadata text.\n   */\n  secondaryText: Slot<'span'>;\n\n  /**\n   * Tertiary text slot. Third displayed metadata text.\n   */\n  tertiaryText: Slot<'span'>;\n\n  /**\n   * Icon slot. Icon displayed in metadata area.\n   */\n  icon: Slot<'span'>;\n\n  /**\n   * Content slot.\n   */\n  content: NonNullable<Slot<'div'>>;\n\n  /**\n   * Details button slot. Used to expand/collapse the reference.\n   */\n  detailsButton: Slot<typeof Button>;\n};\n\n/**\n * Reference Props\n */\nexport type ReferenceProps = ComponentProps<Partial<ReferenceSlots>> &\n  CopilotMode & {\n    /**\n     * Numeric index associated with `Citation`.\n     */\n    index: number;\n\n    /**\n     * HREF back to the `Citation` this `Reference` is associated with.\n     */\n    citationHref?: string;\n\n    /**\n     * Unique ID associated with this `Reference`.\n     */\n    referenceId?: string;\n\n    /**\n     * Text snippet from the reference source.\n     */\n    excerpt?: string;\n\n    /**\n     * @deprecated Inline layout is the only one that is available, use `Preview` component instead for an equivalent to a `Reference` with a popover layout inside of a `Popover`.\n     */\n    layout?: 'inline' | 'popover';\n  };\n\n/**\n * State used in rendering Reference\n */\nexport type ReferenceState = ComponentState<ReferenceSlots> &\n  Required<Pick<ReferenceProps, 'mode' | 'layout' | 'index'>> & {\n    /**\n     * State used to renderer the `Reference` in an expanded state.\n     */\n    isExpanded: boolean;\n  };\n"],"names":[],"rangeMappings":";;","mappings":"AAqGA;;CAEC,GACD,WAMI"}
+{"version":3,"sources":["Reference.types.ts"],"sourcesContent":["import type { CopilotMode } from '@fluentui-copilot/react-provider';\nimport type { Button, ComponentProps, ComponentState, Slot } from '@fluentui/react-components';\n\n/** deprecated Use ReferenceV2 component, hooks and types instead. */\nexport type ReferenceSlots = {\n  /**\n   * The root slot.\n   */\n  root: NonNullable<Slot<'div'>>;\n\n  /**\n   * Citation slot. Displays a `Citation`. Set the `null` to hide the citation.\n   */\n  citation: Slot<'div'>;\n\n  /**\n   * Media slot. Used to display Avatars, Icons, etc.\n   */\n  media: Slot<'div'>;\n\n  /**\n   * Actions slot.\n   */\n  actions: Slot<'div'>;\n\n  /**\n   * Label slot. Primary description of the reference.\n   */\n  label: NonNullable<Slot<'div'>>;\n\n  /**\n   * Sensitivity slot. Used to display a `SensitivityLabel`.\n   */\n  sensitivity: Slot<'span'>;\n\n  /**\n   * Metadata slot. Container for `primaryText`, `secondaryText`, `tertiaryText` and `icon`.\n   */\n  metadata: NonNullable<Slot<'div'>>;\n\n  /**\n   * Primary text slot. First displayed metadata text.\n   */\n  primaryText: Slot<'span'>;\n\n  /**\n   * Secondary text slot. Second displayed metadata text.\n   */\n  secondaryText: Slot<'span'>;\n\n  /**\n   * Tertiary text slot. Third displayed metadata text.\n   */\n  tertiaryText: Slot<'span'>;\n\n  /**\n   * Icon slot. Icon displayed in metadata area.\n   */\n  icon: Slot<'span'>;\n\n  /**\n   * Content slot.\n   */\n  content: NonNullable<Slot<'div'>>;\n\n  /**\n   * Details button slot. Used to expand/collapse the reference.\n   */\n  detailsButton: Slot<typeof Button>;\n};\n\n/** deprecated Use ReferenceV2 component, hooks and types instead. */\nexport type ReferenceProps = ComponentProps<Partial<ReferenceSlots>> &\n  CopilotMode & {\n    /**\n     * Numeric index associated with `Citation`.\n     */\n    index: number;\n\n    /**\n     * HREF back to the `Citation` this `Reference` is associated with.\n     */\n    citationHref?: string;\n\n    /**\n     * Unique ID associated with this `Reference`.\n     */\n    referenceId?: string;\n\n    /**\n     * Text snippet from the reference source.\n     */\n    excerpt?: string;\n\n    /**\n     * @deprecated Inline layout is the only one that is available, use `Preview` component instead for an equivalent to a `Reference` with a popover layout inside of a `Popover`.\n     */\n    layout?: 'inline' | 'popover';\n  };\n\n/** deprecated Use ReferenceV2 component, hooks and types instead. */\nexport type ReferenceState = ComponentState<ReferenceSlots> &\n  Required<Pick<ReferenceProps, 'mode' | 'layout' | 'index'>> & {\n    /**\n     * State used to renderer the `Reference` in an expanded state.\n     */\n    isExpanded: boolean;\n  };\n"],"names":[],"rangeMappings":"","mappings":"AAoGA,mEAAmE,GACnE,WAMI"}

package/lib/components/Reference/renderReference.js

@@ -1,8 +1,6 @@
 import { jsx as _jsx, jsxs as _jsxs } from "@fluentui/react-jsx-runtime/jsx-runtime";
 import { assertSlots } from '@fluentui/react-components';
-/**
- * Render the final JSX of Reference
- */
+/** deprecated Use ReferenceV2 component, hooks and types instead. */
 export const renderReference_unstable = state => {
   assertSlots(state);
   return /*#__PURE__*/_jsxs(state.root, {

package/lib/components/Reference/renderReference.js.map

@@ -1 +1 @@
-{"version":3,"sources":["renderReference.tsx"],"sourcesContent":["/** @jsxRuntime automatic */\n/** @jsxImportSource @fluentui/react-jsx-runtime */\n\nimport { assertSlots } from '@fluentui/react-components';\n\nimport type { ReferenceState, ReferenceSlots } from './Reference.types';\n\n/**\n * Render the final JSX of Reference\n */\nexport const renderReference_unstable = (state: ReferenceState) => {\n  assertSlots<ReferenceSlots>(state);\n\n  return (\n    <state.root>\n      {state.citation && <state.citation />}\n      {state.media && <state.media />}\n      <state.label />\n      {state.actions && (\n        <state.actions>\n          {state.actions.children}\n          {state.detailsButton && <state.detailsButton />}\n        </state.actions>\n      )}\n      {state.sensitivity && <state.sensitivity />}\n      <state.metadata>\n        {state.primaryText && <state.primaryText />}\n        {state.secondaryText && <state.secondaryText />}\n        {state.tertiaryText && <state.tertiaryText />}\n        {state.icon && <state.icon />}\n        {state.metadata.children}\n      </state.metadata>\n      <state.content />\n    </state.root>\n  );\n};\n"],"names":["assertSlots","renderReference_unstable","state","root","citation","media","label","actions","children","detailsButton","sensitivity","metadata","primaryText","secondaryText","tertiaryText","icon","content"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,0BAA0B,GAC1B,iDAAiD;AAEjD,SAASA,WAAW,QAAQ,6BAA6B;AAIzD;;CAEC,GACD,OAAO,MAAMC,2BAA2B,CAACC;IACvCF,YAA4BE;IAE5B,qBACE,MAACA,MAAMC,IAAI;;YACRD,MAAME,QAAQ,kBAAI,KAACF,MAAME,QAAQ;YACjCF,MAAMG,KAAK,kBAAI,KAACH,MAAMG,KAAK;0BAC5B,KAACH,MAAMI,KAAK;YACXJ,MAAMK,OAAO,kBACZ,MAACL,MAAMK,OAAO;;oBACXL,MAAMK,OAAO,CAACC,QAAQ;oBACtBN,MAAMO,aAAa,kBAAI,KAACP,MAAMO,aAAa;;;YAG/CP,MAAMQ,WAAW,kBAAI,KAACR,MAAMQ,WAAW;0BACxC,MAACR,MAAMS,QAAQ;;oBACZT,MAAMU,WAAW,kBAAI,KAACV,MAAMU,WAAW;oBACvCV,MAAMW,aAAa,kBAAI,KAACX,MAAMW,aAAa;oBAC3CX,MAAMY,YAAY,kBAAI,KAACZ,MAAMY,YAAY;oBACzCZ,MAAMa,IAAI,kBAAI,KAACb,MAAMa,IAAI;oBACzBb,MAAMS,QAAQ,CAACH,QAAQ;;;0BAE1B,KAACN,MAAMc,OAAO;;;AAGpB,EAAE"}
+{"version":3,"sources":["renderReference.tsx"],"sourcesContent":["/** @jsxRuntime automatic */\n/** @jsxImportSource @fluentui/react-jsx-runtime */\n\nimport { assertSlots } from '@fluentui/react-components';\n\nimport type { ReferenceState, ReferenceSlots } from './Reference.types';\n\n/** deprecated Use ReferenceV2 component, hooks and types instead. */\nexport const renderReference_unstable = (state: ReferenceState) => {\n  assertSlots<ReferenceSlots>(state);\n\n  return (\n    <state.root>\n      {state.citation && <state.citation />}\n      {state.media && <state.media />}\n      <state.label />\n      {state.actions && (\n        <state.actions>\n          {state.actions.children}\n          {state.detailsButton && <state.detailsButton />}\n        </state.actions>\n      )}\n      {state.sensitivity && <state.sensitivity />}\n      <state.metadata>\n        {state.primaryText && <state.primaryText />}\n        {state.secondaryText && <state.secondaryText />}\n        {state.tertiaryText && <state.tertiaryText />}\n        {state.icon && <state.icon />}\n        {state.metadata.children}\n      </state.metadata>\n      <state.content />\n    </state.root>\n  );\n};\n"],"names":["assertSlots","renderReference_unstable","state","root","citation","media","label","actions","children","detailsButton","sensitivity","metadata","primaryText","secondaryText","tertiaryText","icon","content"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,0BAA0B,GAC1B,iDAAiD;AAEjD,SAASA,WAAW,QAAQ,6BAA6B;AAIzD,mEAAmE,GACnE,OAAO,MAAMC,2BAA2B,CAACC;IACvCF,YAA4BE;IAE5B,qBACE,MAACA,MAAMC,IAAI;;YACRD,MAAME,QAAQ,kBAAI,KAACF,MAAME,QAAQ;YACjCF,MAAMG,KAAK,kBAAI,KAACH,MAAMG,KAAK;0BAC5B,KAACH,MAAMI,KAAK;YACXJ,MAAMK,OAAO,kBACZ,MAACL,MAAMK,OAAO;;oBACXL,MAAMK,OAAO,CAACC,QAAQ;oBACtBN,MAAMO,aAAa,kBAAI,KAACP,MAAMO,aAAa;;;YAG/CP,MAAMQ,WAAW,kBAAI,KAACR,MAAMQ,WAAW;0BACxC,MAACR,MAAMS,QAAQ;;oBACZT,MAAMU,WAAW,kBAAI,KAACV,MAAMU,WAAW;oBACvCV,MAAMW,aAAa,kBAAI,KAACX,MAAMW,aAAa;oBAC3CX,MAAMY,YAAY,kBAAI,KAACZ,MAAMY,YAAY;oBACzCZ,MAAMa,IAAI,kBAAI,KAACb,MAAMa,IAAI;oBACzBb,MAAMS,QAAQ,CAACH,QAAQ;;;0BAE1B,KAACN,MAAMc,OAAO;;;AAGpB,EAAE"}

package/lib/components/Reference/useReference.js

@@ -13,6 +13,8 @@ import { useCopilotMode } from '@fluentui-copilot/react-provider';
  *
  * @param props - props from this instance of Reference
  * @param ref - reference to root HTMLElement of Reference
+ *
+ * deprecated Use ReferenceV2 component, hooks and types instead.
  */
 export const useReference_unstable = (props, ref) => {
   const {

package/lib/components/Reference/useReference.js.map

@@ -1 +1 @@
-{"version":3,"sources":["useReference.tsx"],"sourcesContent":["import * as React from 'react';\nimport {\n  Button,\n  Caption1,\n  getIntrinsicElementProps,\n  mergeCallbacks,\n  mergeClasses,\n  slot,\n  useId,\n  usePopoverContext_unstable as usePopoverContext,\n} from '@fluentui/react-components';\nimport {\n  ChevronDown24Regular,\n  ChevronUp24Regular,\n  ChevronDown16Regular,\n  ChevronUp16Regular,\n} from '@fluentui/react-icons';\nimport { referenceExtraClassNames } from './useReferenceStyles.styles';\nimport { Citation } from '../Citation';\nimport type { ReferenceProps, ReferenceState } from './Reference.types';\nimport { useReferenceGroupSetOpen } from '../../contexts/ReferenceGroupContext';\nimport { useCopilotMode } from '@fluentui-copilot/react-provider';\n\n/**\n * Create the state required to render Reference.\n *\n * The returned state can be modified with hooks such as useReferenceStyles_unstable,\n * before being passed to renderReference_unstable.\n *\n * @param props - props from this instance of Reference\n * @param ref - reference to root HTMLElement of Reference\n */\nexport const useReference_unstable = (props: ReferenceProps, ref: React.Ref<HTMLDivElement>): ReferenceState => {\n  const { index, referenceId, citationHref, excerpt, layout = 'inline' } = props;\n\n  const mode = useCopilotMode(props.mode);\n\n  const labelId = useId();\n  const mediaId = useId();\n  const [isExpanded, setIsExpanded] = React.useState(layout === 'popover' ? true : false);\n\n  const setPopoverOpen = usePopoverContext(context => context.setOpen);\n\n  const onExpandClick: React.MouseEventHandler<HTMLButtonElement> = _e => {\n    setIsExpanded(!isExpanded);\n  };\n\n  const label = slot.always(props.label, {\n    defaultProps: { id: labelId },\n    elementType: 'div',\n  });\n  const media = slot.optional(props.media, { defaultProps: { id: mediaId }, elementType: 'div' });\n  if (media && React.isValidElement<HTMLElement>(media.children)) {\n    media.children = React.cloneElement(media.children, {\n      className: mergeClasses(media.children.props.className, referenceExtraClassNames.mediaChild),\n    });\n  }\n\n  if (media?.id) {\n    label['aria-describedby'] = label['aria-describedby']?.concat(media.id) ?? media.id;\n  }\n\n  const ariaLabelledByProp = props['aria-labelledby'];\n  const groupSemantics = React.useMemo(() => {\n    return layout === 'inline'\n      ? {\n          role: 'group',\n          'aria-labelledby': `${ariaLabelledByProp ?? ''} ${label.id}`,\n          tabIndex: -1,\n        }\n      : {};\n  }, [layout, ariaLabelledByProp, label.id]);\n\n  // Within a popup, a citation should function as a close button\n  const citationProps = React.useMemo(() => {\n    const onPopoverCloseClick = (e: React.MouseEvent<HTMLAnchorElement>) => {\n      setPopoverOpen(e, false);\n\n      // don't navigate\n      e.preventDefault();\n    };\n\n    return layout === 'popover'\n      ? {\n          referenceHref: '#',\n          tabIndex: -1,\n          'aria-label': `Reference ${index}, close`,\n          onClick: onPopoverCloseClick,\n        }\n      : {\n          referenceHref: citationHref,\n        };\n  }, [layout, citationHref, index, setPopoverOpen]);\n\n  const state: ReferenceState = {\n    isExpanded,\n    mode: layout === 'popover' ? 'sidecar' : mode,\n    layout,\n    index,\n    components: {\n      root: 'div',\n      citation: 'div',\n      media: 'div',\n      actions: 'div',\n      label: 'div',\n      sensitivity: 'span',\n      metadata: 'div',\n      content: 'div',\n      primaryText: 'span',\n      secondaryText: 'span',\n      tertiaryText: 'span',\n      icon: 'span',\n      detailsButton: Button,\n    },\n    root: slot.always(\n      getIntrinsicElementProps('div', {\n        ref,\n        id: referenceId,\n        ...groupSemantics,\n        ...props,\n      }),\n      { elementType: 'div' },\n    ),\n    citation: slot.optional(props.citation, {\n      defaultProps: {\n        children: (\n          <Citation block {...citationProps}>\n            {index}\n          </Citation>\n        ),\n      },\n      renderByDefault: true,\n      elementType: 'div',\n    }),\n    media,\n    actions: slot.optional(layout === 'inline' ? props.actions : null, {\n      renderByDefault: true,\n      elementType: 'div',\n    }),\n    label,\n    sensitivity: slot.optional(props.sensitivity, { elementType: 'span' }),\n    metadata: slot.always(props.metadata, { elementType: 'div' }),\n    primaryText: slot.optional(props.primaryText, {\n      defaultProps: {\n        hidden: !isExpanded,\n      },\n      elementType: 'span',\n    }),\n    secondaryText: slot.optional(props.secondaryText, {\n      defaultProps: {\n        hidden: !isExpanded,\n      },\n      elementType: 'span',\n    }),\n    tertiaryText: slot.optional(props.tertiaryText, {\n      defaultProps: {\n        hidden: !isExpanded,\n      },\n      elementType: 'span',\n    }),\n    icon: slot.optional(props.icon, { elementType: 'span' }),\n    content: slot.always(props.content, {\n      defaultProps: {\n        children: excerpt && <Caption1>{excerpt}</Caption1>,\n      },\n      elementType: 'div',\n    }),\n    detailsButton: slot.optional(layout === 'inline' ? props.detailsButton : null, {\n      defaultProps: {\n        appearance: 'transparent',\n        'aria-expanded': isExpanded,\n        'aria-label': 'show details',\n        size: mode === 'sidecar' ? 'small' : 'medium',\n        icon: {\n          children: getIcon(isExpanded, mode),\n        },\n      },\n      renderByDefault: true,\n      elementType: Button,\n    }),\n  };\n\n  if (state.detailsButton) {\n    const onClick = state.detailsButton.onClick as React.MouseEventHandler<HTMLButtonElement>;\n    state.detailsButton.onClick = mergeCallbacks(onClick, onExpandClick);\n  }\n\n  const referenceGroupSetOpen = useReferenceGroupSetOpen();\n  const onTargettedByCitation = (e: React.FocusEvent<HTMLElement>) => {\n    const relatedTargetHash: string | undefined = (e.relatedTarget as HTMLAnchorElement)?.hash;\n    if (relatedTargetHash && relatedTargetHash.substring(1) === referenceId) {\n      referenceGroupSetOpen();\n      setIsExpanded(true);\n    }\n  };\n  state.root.onFocus = mergeCallbacks(state.root.onFocus, onTargettedByCitation);\n\n  return state;\n};\n\nconst getIcon = (isExpanded: boolean, mode: ReferenceProps['mode']): JSX.Element => {\n  if (mode === 'sidecar') {\n    return !isExpanded ? <ChevronDown16Regular /> : <ChevronUp16Regular />;\n  }\n\n  return !isExpanded ? <ChevronDown24Regular /> : <ChevronUp24Regular />;\n};\n"],"names":["React","Button","Caption1","getIntrinsicElementProps","mergeCallbacks","mergeClasses","slot","useId","usePopoverContext_unstable","usePopoverContext","ChevronDown24Regular","ChevronUp24Regular","ChevronDown16Regular","ChevronUp16Regular","referenceExtraClassNames","Citation","useReferenceGroupSetOpen","useCopilotMode","useReference_unstable","props","ref","index","referenceId","citationHref","excerpt","layout","mode","labelId","mediaId","isExpanded","setIsExpanded","useState","setPopoverOpen","context","setOpen","onExpandClick","_e","label","always","defaultProps","id","elementType","media","optional","isValidElement","children","cloneElement","className","mediaChild","concat","ariaLabelledByProp","groupSemantics","useMemo","role","tabIndex","citationProps","onPopoverCloseClick","e","preventDefault","referenceHref","onClick","state","components","root","citation","actions","sensitivity","metadata","content","primaryText","secondaryText","tertiaryText","icon","detailsButton","block","renderByDefault","hidden","appearance","size","getIcon","referenceGroupSetOpen","onTargettedByCitation","relatedTargetHash","relatedTarget","hash","substring","onFocus"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,YAAYA,WAAW,QAAQ;AAC/B,SACEC,MAAM,EACNC,QAAQ,EACRC,wBAAwB,EACxBC,cAAc,EACdC,YAAY,EACZC,IAAI,EACJC,KAAK,EACLC,8BAA8BC,iBAAiB,QAC1C,6BAA6B;AACpC,SACEC,oBAAoB,EACpBC,kBAAkB,EAClBC,oBAAoB,EACpBC,kBAAkB,QACb,wBAAwB;AAC/B,SAASC,wBAAwB,QAAQ,8BAA8B;AACvE,SAASC,QAAQ,QAAQ,cAAc;AAEvC,SAASC,wBAAwB,QAAQ,uCAAuC;AAChF,SAASC,cAAc,QAAQ,mCAAmC;AAElE;;;;;;;;CAQC,GACD,OAAO,MAAMC,wBAAwB,CAACC,OAAuBC;IAC3D,MAAM,EAAEC,KAAK,EAAEC,WAAW,EAAEC,YAAY,EAAEC,OAAO,EAAEC,SAAS,QAAQ,EAAE,GAAGN;IAEzE,MAAMO,OAAOT,eAAeE,MAAMO,IAAI;IAEtC,MAAMC,UAAUpB;IAChB,MAAMqB,UAAUrB;IAChB,MAAM,CAACsB,YAAYC,cAAc,GAAG9B,MAAM+B,QAAQ,CAACN,WAAW,YAAY,OAAO;IAEjF,MAAMO,iBAAiBvB,kBAAkBwB,CAAAA,UAAWA,QAAQC,OAAO;IAEnE,MAAMC,gBAA4DC,CAAAA;QAChEN,cAAc,CAACD;IACjB;IAEA,MAAMQ,QAAQ/B,KAAKgC,MAAM,CAACnB,MAAMkB,KAAK,EAAE;QACrCE,cAAc;YAAEC,IAAIb;QAAQ;QAC5Bc,aAAa;IACf;IACA,MAAMC,QAAQpC,KAAKqC,QAAQ,CAACxB,MAAMuB,KAAK,EAAE;QAAEH,cAAc;YAAEC,IAAIZ;QAAQ;QAAGa,aAAa;IAAM;IAC7F,IAAIC,uBAAS1C,MAAM4C,cAAc,CAAcF,MAAMG,QAAQ,GAAG;QAC9DH,MAAMG,QAAQ,iBAAG7C,MAAM8C,YAAY,CAACJ,MAAMG,QAAQ,EAAE;YAClDE,WAAW1C,aAAaqC,MAAMG,QAAQ,CAAC1B,KAAK,CAAC4B,SAAS,EAAEjC,yBAAyBkC,UAAU;QAC7F;IACF;IAEA,IAAIN,kBAAAA,4BAAAA,MAAOF,EAAE,EAAE;YACeH;YAAAA;QAA5BA,KAAK,CAAC,mBAAmB,GAAGA,CAAAA,iCAAAA,yBAAAA,KAAK,CAAC,mBAAmB,cAAzBA,6CAAAA,uBAA2BY,MAAM,CAACP,MAAMF,EAAE,eAA1CH,2CAAAA,gCAA+CK,MAAMF,EAAE;IACrF;IAEA,MAAMU,qBAAqB/B,KAAK,CAAC,kBAAkB;IACnD,MAAMgC,iBAAiBnD,MAAMoD,OAAO,CAAC;QACnC,OAAO3B,WAAW,WACd;YACE4B,MAAM;YACN,mBAAmB,CAAC,EAAEH,+BAAAA,gCAAAA,qBAAsB,GAAG,CAAC,EAAEb,MAAMG,EAAE,CAAC,CAAC;YAC5Dc,UAAU,CAAC;QACb,IACA,CAAC;IACP,GAAG;QAAC7B;QAAQyB;QAAoBb,MAAMG,EAAE;KAAC;IAEzC,+DAA+D;IAC/D,MAAMe,gBAAgBvD,MAAMoD,OAAO,CAAC;QAClC,MAAMI,sBAAsB,CAACC;YAC3BzB,eAAeyB,GAAG;YAElB,iBAAiB;YACjBA,EAAEC,cAAc;QAClB;QAEA,OAAOjC,WAAW,YACd;YACEkC,eAAe;YACfL,UAAU,CAAC;YACX,cAAc,CAAC,UAAU,EAAEjC,MAAM,OAAO,CAAC;YACzCuC,SAASJ;QACX,IACA;YACEG,eAAepC;QACjB;IACN,GAAG;QAACE;QAAQF;QAAcF;QAAOW;KAAe;IAEhD,MAAM6B,QAAwB;QAC5BhC;QACAH,MAAMD,WAAW,YAAY,YAAYC;QACzCD;QACAJ;QACAyC,YAAY;YACVC,MAAM;YACNC,UAAU;YACVtB,OAAO;YACPuB,SAAS;YACT5B,OAAO;YACP6B,aAAa;YACbC,UAAU;YACVC,SAAS;YACTC,aAAa;YACbC,eAAe;YACfC,cAAc;YACdC,MAAM;YACNC,eAAexE;QACjB;QACA8D,MAAMzD,KAAKgC,MAAM,CACfnC,yBAAyB,OAAO;YAC9BiB;YACAoB,IAAIlB;YACJ,GAAG6B,cAAc;YACjB,GAAGhC,KAAK;QACV,IACA;YAAEsB,aAAa;QAAM;QAEvBuB,UAAU1D,KAAKqC,QAAQ,CAACxB,MAAM6C,QAAQ,EAAE;YACtCzB,cAAc;gBACZM,wBACE,oBAAC9B;oBAAS2D,OAAAA;oBAAO,GAAGnB,aAAa;mBAC9BlC;YAGP;YACAsD,iBAAiB;YACjBlC,aAAa;QACf;QACAC;QACAuB,SAAS3D,KAAKqC,QAAQ,CAAClB,WAAW,WAAWN,MAAM8C,OAAO,GAAG,MAAM;YACjEU,iBAAiB;YACjBlC,aAAa;QACf;QACAJ;QACA6B,aAAa5D,KAAKqC,QAAQ,CAACxB,MAAM+C,WAAW,EAAE;YAAEzB,aAAa;QAAO;QACpE0B,UAAU7D,KAAKgC,MAAM,CAACnB,MAAMgD,QAAQ,EAAE;YAAE1B,aAAa;QAAM;QAC3D4B,aAAa/D,KAAKqC,QAAQ,CAACxB,MAAMkD,WAAW,EAAE;YAC5C9B,cAAc;gBACZqC,QAAQ,CAAC/C;YACX;YACAY,aAAa;QACf;QACA6B,eAAehE,KAAKqC,QAAQ,CAACxB,MAAMmD,aAAa,EAAE;YAChD/B,cAAc;gBACZqC,QAAQ,CAAC/C;YACX;YACAY,aAAa;QACf;QACA8B,cAAcjE,KAAKqC,QAAQ,CAACxB,MAAMoD,YAAY,EAAE;YAC9ChC,cAAc;gBACZqC,QAAQ,CAAC/C;YACX;YACAY,aAAa;QACf;QACA+B,MAAMlE,KAAKqC,QAAQ,CAACxB,MAAMqD,IAAI,EAAE;YAAE/B,aAAa;QAAO;QACtD2B,SAAS9D,KAAKgC,MAAM,CAACnB,MAAMiD,OAAO,EAAE;YAClC7B,cAAc;gBACZM,UAAUrB,yBAAW,oBAACtB,gBAAUsB;YAClC;YACAiB,aAAa;QACf;QACAgC,eAAenE,KAAKqC,QAAQ,CAAClB,WAAW,WAAWN,MAAMsD,aAAa,GAAG,MAAM;YAC7ElC,cAAc;gBACZsC,YAAY;gBACZ,iBAAiBhD;gBACjB,cAAc;gBACdiD,MAAMpD,SAAS,YAAY,UAAU;gBACrC8C,MAAM;oBACJ3B,UAAUkC,QAAQlD,YAAYH;gBAChC;YACF;YACAiD,iBAAiB;YACjBlC,aAAaxC;QACf;IACF;IAEA,IAAI4D,MAAMY,aAAa,EAAE;QACvB,MAAMb,UAAUC,MAAMY,aAAa,CAACb,OAAO;QAC3CC,MAAMY,aAAa,CAACb,OAAO,GAAGxD,eAAewD,SAASzB;IACxD;IAEA,MAAM6C,wBAAwBhE;IAC9B,MAAMiE,wBAAwB,CAACxB;YACkBA;QAA/C,MAAMyB,qBAAyCzB,mBAAAA,EAAE0B,aAAa,cAAf1B,uCAAD,AAACA,iBAAuC2B,IAAI;QAC1F,IAAIF,qBAAqBA,kBAAkBG,SAAS,CAAC,OAAO/D,aAAa;YACvE0D;YACAlD,cAAc;QAChB;IACF;IACA+B,MAAME,IAAI,CAACuB,OAAO,GAAGlF,eAAeyD,MAAME,IAAI,CAACuB,OAAO,EAAEL;IAExD,OAAOpB;AACT,EAAE;AAEF,MAAMkB,UAAU,CAAClD,YAAqBH;IACpC,IAAIA,SAAS,WAAW;QACtB,OAAO,CAACG,2BAAa,oBAACjB,4CAA0B,oBAACC;IACnD;IAEA,OAAO,CAACgB,2BAAa,oBAACnB,4CAA0B,oBAACC;AACnD"}
+{"version":3,"sources":["useReference.tsx"],"sourcesContent":["import * as React from 'react';\nimport {\n  Button,\n  Caption1,\n  getIntrinsicElementProps,\n  mergeCallbacks,\n  mergeClasses,\n  slot,\n  useId,\n  usePopoverContext_unstable as usePopoverContext,\n} from '@fluentui/react-components';\nimport {\n  ChevronDown24Regular,\n  ChevronUp24Regular,\n  ChevronDown16Regular,\n  ChevronUp16Regular,\n} from '@fluentui/react-icons';\nimport { referenceExtraClassNames } from './useReferenceStyles.styles';\nimport { Citation } from '../Citation';\nimport type { ReferenceProps, ReferenceState } from './Reference.types';\nimport { useReferenceGroupSetOpen } from '../../contexts/ReferenceGroupContext';\nimport { useCopilotMode } from '@fluentui-copilot/react-provider';\n\n/**\n * Create the state required to render Reference.\n *\n * The returned state can be modified with hooks such as useReferenceStyles_unstable,\n * before being passed to renderReference_unstable.\n *\n * @param props - props from this instance of Reference\n * @param ref - reference to root HTMLElement of Reference\n *\n * deprecated Use ReferenceV2 component, hooks and types instead.\n */\nexport const useReference_unstable = (props: ReferenceProps, ref: React.Ref<HTMLDivElement>): ReferenceState => {\n  const { index, referenceId, citationHref, excerpt, layout = 'inline' } = props;\n\n  const mode = useCopilotMode(props.mode);\n\n  const labelId = useId();\n  const mediaId = useId();\n  const [isExpanded, setIsExpanded] = React.useState(layout === 'popover' ? true : false);\n\n  const setPopoverOpen = usePopoverContext(context => context.setOpen);\n\n  const onExpandClick: React.MouseEventHandler<HTMLButtonElement> = _e => {\n    setIsExpanded(!isExpanded);\n  };\n\n  const label = slot.always(props.label, {\n    defaultProps: { id: labelId },\n    elementType: 'div',\n  });\n  const media = slot.optional(props.media, { defaultProps: { id: mediaId }, elementType: 'div' });\n  if (media && React.isValidElement<HTMLElement>(media.children)) {\n    media.children = React.cloneElement(media.children, {\n      className: mergeClasses(media.children.props.className, referenceExtraClassNames.mediaChild),\n    });\n  }\n\n  if (media?.id) {\n    label['aria-describedby'] = label['aria-describedby']?.concat(media.id) ?? media.id;\n  }\n\n  const ariaLabelledByProp = props['aria-labelledby'];\n  const groupSemantics = React.useMemo(() => {\n    return layout === 'inline'\n      ? {\n          role: 'group',\n          'aria-labelledby': `${ariaLabelledByProp ?? ''} ${label.id}`,\n          tabIndex: -1,\n        }\n      : {};\n  }, [layout, ariaLabelledByProp, label.id]);\n\n  // Within a popup, a citation should function as a close button\n  const citationProps = React.useMemo(() => {\n    const onPopoverCloseClick = (e: React.MouseEvent<HTMLAnchorElement>) => {\n      setPopoverOpen(e, false);\n\n      // don't navigate\n      e.preventDefault();\n    };\n\n    return layout === 'popover'\n      ? {\n          referenceHref: '#',\n          tabIndex: -1,\n          'aria-label': `Reference ${index}, close`,\n          onClick: onPopoverCloseClick,\n        }\n      : {\n          referenceHref: citationHref,\n        };\n  }, [layout, citationHref, index, setPopoverOpen]);\n\n  const state: ReferenceState = {\n    isExpanded,\n    mode: layout === 'popover' ? 'sidecar' : mode,\n    layout,\n    index,\n    components: {\n      root: 'div',\n      citation: 'div',\n      media: 'div',\n      actions: 'div',\n      label: 'div',\n      sensitivity: 'span',\n      metadata: 'div',\n      content: 'div',\n      primaryText: 'span',\n      secondaryText: 'span',\n      tertiaryText: 'span',\n      icon: 'span',\n      detailsButton: Button,\n    },\n    root: slot.always(\n      getIntrinsicElementProps('div', {\n        ref,\n        id: referenceId,\n        ...groupSemantics,\n        ...props,\n      }),\n      { elementType: 'div' },\n    ),\n    citation: slot.optional(props.citation, {\n      defaultProps: {\n        children: (\n          <Citation block {...citationProps}>\n            {index}\n          </Citation>\n        ),\n      },\n      renderByDefault: true,\n      elementType: 'div',\n    }),\n    media,\n    actions: slot.optional(layout === 'inline' ? props.actions : null, {\n      renderByDefault: true,\n      elementType: 'div',\n    }),\n    label,\n    sensitivity: slot.optional(props.sensitivity, { elementType: 'span' }),\n    metadata: slot.always(props.metadata, { elementType: 'div' }),\n    primaryText: slot.optional(props.primaryText, {\n      defaultProps: {\n        hidden: !isExpanded,\n      },\n      elementType: 'span',\n    }),\n    secondaryText: slot.optional(props.secondaryText, {\n      defaultProps: {\n        hidden: !isExpanded,\n      },\n      elementType: 'span',\n    }),\n    tertiaryText: slot.optional(props.tertiaryText, {\n      defaultProps: {\n        hidden: !isExpanded,\n      },\n      elementType: 'span',\n    }),\n    icon: slot.optional(props.icon, { elementType: 'span' }),\n    content: slot.always(props.content, {\n      defaultProps: {\n        children: excerpt && <Caption1>{excerpt}</Caption1>,\n      },\n      elementType: 'div',\n    }),\n    detailsButton: slot.optional(layout === 'inline' ? props.detailsButton : null, {\n      defaultProps: {\n        appearance: 'transparent',\n        'aria-expanded': isExpanded,\n        'aria-label': 'show details',\n        size: mode === 'sidecar' ? 'small' : 'medium',\n        icon: {\n          children: getIcon(isExpanded, mode),\n        },\n      },\n      renderByDefault: true,\n      elementType: Button,\n    }),\n  };\n\n  if (state.detailsButton) {\n    const onClick = state.detailsButton.onClick as React.MouseEventHandler<HTMLButtonElement>;\n    state.detailsButton.onClick = mergeCallbacks(onClick, onExpandClick);\n  }\n\n  const referenceGroupSetOpen = useReferenceGroupSetOpen();\n  const onTargettedByCitation = (e: React.FocusEvent<HTMLElement>) => {\n    const relatedTargetHash: string | undefined = (e.relatedTarget as HTMLAnchorElement)?.hash;\n    if (relatedTargetHash && relatedTargetHash.substring(1) === referenceId) {\n      referenceGroupSetOpen();\n      setIsExpanded(true);\n    }\n  };\n  state.root.onFocus = mergeCallbacks(state.root.onFocus, onTargettedByCitation);\n\n  return state;\n};\n\nconst getIcon = (isExpanded: boolean, mode: ReferenceProps['mode']): JSX.Element => {\n  if (mode === 'sidecar') {\n    return !isExpanded ? <ChevronDown16Regular /> : <ChevronUp16Regular />;\n  }\n\n  return !isExpanded ? <ChevronDown24Regular /> : <ChevronUp24Regular />;\n};\n"],"names":["React","Button","Caption1","getIntrinsicElementProps","mergeCallbacks","mergeClasses","slot","useId","usePopoverContext_unstable","usePopoverContext","ChevronDown24Regular","ChevronUp24Regular","ChevronDown16Regular","ChevronUp16Regular","referenceExtraClassNames","Citation","useReferenceGroupSetOpen","useCopilotMode","useReference_unstable","props","ref","index","referenceId","citationHref","excerpt","layout","mode","labelId","mediaId","isExpanded","setIsExpanded","useState","setPopoverOpen","context","setOpen","onExpandClick","_e","label","always","defaultProps","id","elementType","media","optional","isValidElement","children","cloneElement","className","mediaChild","concat","ariaLabelledByProp","groupSemantics","useMemo","role","tabIndex","citationProps","onPopoverCloseClick","e","preventDefault","referenceHref","onClick","state","components","root","citation","actions","sensitivity","metadata","content","primaryText","secondaryText","tertiaryText","icon","detailsButton","block","renderByDefault","hidden","appearance","size","getIcon","referenceGroupSetOpen","onTargettedByCitation","relatedTargetHash","relatedTarget","hash","substring","onFocus"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,YAAYA,WAAW,QAAQ;AAC/B,SACEC,MAAM,EACNC,QAAQ,EACRC,wBAAwB,EACxBC,cAAc,EACdC,YAAY,EACZC,IAAI,EACJC,KAAK,EACLC,8BAA8BC,iBAAiB,QAC1C,6BAA6B;AACpC,SACEC,oBAAoB,EACpBC,kBAAkB,EAClBC,oBAAoB,EACpBC,kBAAkB,QACb,wBAAwB;AAC/B,SAASC,wBAAwB,QAAQ,8BAA8B;AACvE,SAASC,QAAQ,QAAQ,cAAc;AAEvC,SAASC,wBAAwB,QAAQ,uCAAuC;AAChF,SAASC,cAAc,QAAQ,mCAAmC;AAElE;;;;;;;;;;CAUC,GACD,OAAO,MAAMC,wBAAwB,CAACC,OAAuBC;IAC3D,MAAM,EAAEC,KAAK,EAAEC,WAAW,EAAEC,YAAY,EAAEC,OAAO,EAAEC,SAAS,QAAQ,EAAE,GAAGN;IAEzE,MAAMO,OAAOT,eAAeE,MAAMO,IAAI;IAEtC,MAAMC,UAAUpB;IAChB,MAAMqB,UAAUrB;IAChB,MAAM,CAACsB,YAAYC,cAAc,GAAG9B,MAAM+B,QAAQ,CAACN,WAAW,YAAY,OAAO;IAEjF,MAAMO,iBAAiBvB,kBAAkBwB,CAAAA,UAAWA,QAAQC,OAAO;IAEnE,MAAMC,gBAA4DC,CAAAA;QAChEN,cAAc,CAACD;IACjB;IAEA,MAAMQ,QAAQ/B,KAAKgC,MAAM,CAACnB,MAAMkB,KAAK,EAAE;QACrCE,cAAc;YAAEC,IAAIb;QAAQ;QAC5Bc,aAAa;IACf;IACA,MAAMC,QAAQpC,KAAKqC,QAAQ,CAACxB,MAAMuB,KAAK,EAAE;QAAEH,cAAc;YAAEC,IAAIZ;QAAQ;QAAGa,aAAa;IAAM;IAC7F,IAAIC,uBAAS1C,MAAM4C,cAAc,CAAcF,MAAMG,QAAQ,GAAG;QAC9DH,MAAMG,QAAQ,iBAAG7C,MAAM8C,YAAY,CAACJ,MAAMG,QAAQ,EAAE;YAClDE,WAAW1C,aAAaqC,MAAMG,QAAQ,CAAC1B,KAAK,CAAC4B,SAAS,EAAEjC,yBAAyBkC,UAAU;QAC7F;IACF;IAEA,IAAIN,kBAAAA,4BAAAA,MAAOF,EAAE,EAAE;YACeH;YAAAA;QAA5BA,KAAK,CAAC,mBAAmB,GAAGA,CAAAA,iCAAAA,yBAAAA,KAAK,CAAC,mBAAmB,cAAzBA,6CAAAA,uBAA2BY,MAAM,CAACP,MAAMF,EAAE,eAA1CH,2CAAAA,gCAA+CK,MAAMF,EAAE;IACrF;IAEA,MAAMU,qBAAqB/B,KAAK,CAAC,kBAAkB;IACnD,MAAMgC,iBAAiBnD,MAAMoD,OAAO,CAAC;QACnC,OAAO3B,WAAW,WACd;YACE4B,MAAM;YACN,mBAAmB,CAAC,EAAEH,+BAAAA,gCAAAA,qBAAsB,GAAG,CAAC,EAAEb,MAAMG,EAAE,CAAC,CAAC;YAC5Dc,UAAU,CAAC;QACb,IACA,CAAC;IACP,GAAG;QAAC7B;QAAQyB;QAAoBb,MAAMG,EAAE;KAAC;IAEzC,+DAA+D;IAC/D,MAAMe,gBAAgBvD,MAAMoD,OAAO,CAAC;QAClC,MAAMI,sBAAsB,CAACC;YAC3BzB,eAAeyB,GAAG;YAElB,iBAAiB;YACjBA,EAAEC,cAAc;QAClB;QAEA,OAAOjC,WAAW,YACd;YACEkC,eAAe;YACfL,UAAU,CAAC;YACX,cAAc,CAAC,UAAU,EAAEjC,MAAM,OAAO,CAAC;YACzCuC,SAASJ;QACX,IACA;YACEG,eAAepC;QACjB;IACN,GAAG;QAACE;QAAQF;QAAcF;QAAOW;KAAe;IAEhD,MAAM6B,QAAwB;QAC5BhC;QACAH,MAAMD,WAAW,YAAY,YAAYC;QACzCD;QACAJ;QACAyC,YAAY;YACVC,MAAM;YACNC,UAAU;YACVtB,OAAO;YACPuB,SAAS;YACT5B,OAAO;YACP6B,aAAa;YACbC,UAAU;YACVC,SAAS;YACTC,aAAa;YACbC,eAAe;YACfC,cAAc;YACdC,MAAM;YACNC,eAAexE;QACjB;QACA8D,MAAMzD,KAAKgC,MAAM,CACfnC,yBAAyB,OAAO;YAC9BiB;YACAoB,IAAIlB;YACJ,GAAG6B,cAAc;YACjB,GAAGhC,KAAK;QACV,IACA;YAAEsB,aAAa;QAAM;QAEvBuB,UAAU1D,KAAKqC,QAAQ,CAACxB,MAAM6C,QAAQ,EAAE;YACtCzB,cAAc;gBACZM,wBACE,oBAAC9B;oBAAS2D,OAAAA;oBAAO,GAAGnB,aAAa;mBAC9BlC;YAGP;YACAsD,iBAAiB;YACjBlC,aAAa;QACf;QACAC;QACAuB,SAAS3D,KAAKqC,QAAQ,CAAClB,WAAW,WAAWN,MAAM8C,OAAO,GAAG,MAAM;YACjEU,iBAAiB;YACjBlC,aAAa;QACf;QACAJ;QACA6B,aAAa5D,KAAKqC,QAAQ,CAACxB,MAAM+C,WAAW,EAAE;YAAEzB,aAAa;QAAO;QACpE0B,UAAU7D,KAAKgC,MAAM,CAACnB,MAAMgD,QAAQ,EAAE;YAAE1B,aAAa;QAAM;QAC3D4B,aAAa/D,KAAKqC,QAAQ,CAACxB,MAAMkD,WAAW,EAAE;YAC5C9B,cAAc;gBACZqC,QAAQ,CAAC/C;YACX;YACAY,aAAa;QACf;QACA6B,eAAehE,KAAKqC,QAAQ,CAACxB,MAAMmD,aAAa,EAAE;YAChD/B,cAAc;gBACZqC,QAAQ,CAAC/C;YACX;YACAY,aAAa;QACf;QACA8B,cAAcjE,KAAKqC,QAAQ,CAACxB,MAAMoD,YAAY,EAAE;YAC9ChC,cAAc;gBACZqC,QAAQ,CAAC/C;YACX;YACAY,aAAa;QACf;QACA+B,MAAMlE,KAAKqC,QAAQ,CAACxB,MAAMqD,IAAI,EAAE;YAAE/B,aAAa;QAAO;QACtD2B,SAAS9D,KAAKgC,MAAM,CAACnB,MAAMiD,OAAO,EAAE;YAClC7B,cAAc;gBACZM,UAAUrB,yBAAW,oBAACtB,gBAAUsB;YAClC;YACAiB,aAAa;QACf;QACAgC,eAAenE,KAAKqC,QAAQ,CAAClB,WAAW,WAAWN,MAAMsD,aAAa,GAAG,MAAM;YAC7ElC,cAAc;gBACZsC,YAAY;gBACZ,iBAAiBhD;gBACjB,cAAc;gBACdiD,MAAMpD,SAAS,YAAY,UAAU;gBACrC8C,MAAM;oBACJ3B,UAAUkC,QAAQlD,YAAYH;gBAChC;YACF;YACAiD,iBAAiB;YACjBlC,aAAaxC;QACf;IACF;IAEA,IAAI4D,MAAMY,aAAa,EAAE;QACvB,MAAMb,UAAUC,MAAMY,aAAa,CAACb,OAAO;QAC3CC,MAAMY,aAAa,CAACb,OAAO,GAAGxD,eAAewD,SAASzB;IACxD;IAEA,MAAM6C,wBAAwBhE;IAC9B,MAAMiE,wBAAwB,CAACxB;YACkBA;QAA/C,MAAMyB,qBAAyCzB,mBAAAA,EAAE0B,aAAa,cAAf1B,uCAAD,AAACA,iBAAuC2B,IAAI;QAC1F,IAAIF,qBAAqBA,kBAAkBG,SAAS,CAAC,OAAO/D,aAAa;YACvE0D;YACAlD,cAAc;QAChB;IACF;IACA+B,MAAME,IAAI,CAACuB,OAAO,GAAGlF,eAAeyD,MAAME,IAAI,CAACuB,OAAO,EAAEL;IAExD,OAAOpB;AACT,EAAE;AAEF,MAAMkB,UAAU,CAAClD,YAAqBH;IACpC,IAAIA,SAAS,WAAW;QACtB,OAAO,CAACG,2BAAa,oBAACjB,4CAA0B,oBAACC;IACnD;IAEA,OAAO,CAACgB,2BAAa,oBAACnB,4CAA0B,oBAACC;AACnD"}

package/lib/components/Reference/useReferenceStyles.styles.js

@@ -1,4 +1,5 @@
 import { buttonClassNames, __resetStyles, __styles, mergeClasses, shorthands, tokens, typographyStyles } from '@fluentui/react-components';
+/** deprecated Use ReferenceV2 component, hooks and types instead. */
 export const referenceClassNames = {
   root: 'fai-Reference',
   citation: 'fai-Reference__citation',
@@ -14,6 +15,7 @@ export const referenceClassNames = {
   content: 'fai-Reference__content',
   detailsButton: 'fai-Reference__detailsButton'
 };
+/** deprecated Use ReferenceV2 component, hooks and types instead. */
 export const referenceExtraClassNames = {
   text: 'fai-Reference__text',
   mediaChild: 'fai-Reference__mediaChild'
@@ -166,6 +168,8 @@ const useLabelStyles = __styles({
 });
 /**
  * Apply styling to the Reference slots based on the state
+ *
+ * deprecated Use ReferenceV2 component, hooks and types instead.
  */
 export const useReferenceStyles_unstable = state => {
   'use no memo';