chore: adds internal tag on jsdocs for getSlotsNext (#28348)

* chore: adds internal tag on jsdoce for getSlotsNext * fix type on change file
microsoft · Jun 28, 2023 · cbfa9a3 · cbfa9a3
1 parent 8c7436d
commit cbfa9a3
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/change/@fluentui-react-utilities-f1dc6a83-6fd4-4d86-a5ef-b68f5420ea11.json b/change/@fluentui-react-utilities-f1dc6a83-6fd4-4d86-a5ef-b68f5420ea11.json
@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "chore: adds internal tag on jsdoc for getSlotsNext",
+  "packageName": "@fluentui/react-utilities",
+  "email": "bernardo.sunderhus@gmail.com",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/react-components/react-utilities/etc/react-utilities.api.md b/packages/react-components/react-utilities/etc/react-utilities.api.md
@@ -73,7 +73,7 @@ export function getSlots<R extends SlotPropsRecord>(state: ComponentState<R>): {
     slotProps: ObjectSlotProps<R>;
 };
 
-// @public
+// @internal
 export function getSlotsNext<R extends SlotPropsRecord>(state: ComponentState<R>): {
     slots: Slots<R>;
     slotProps: ObjectSlotProps<R>;

diff --git a/packages/react-components/react-utilities/src/compose/getSlotsNext.ts b/packages/react-components/react-utilities/src/compose/getSlotsNext.ts
@@ -4,6 +4,11 @@ import { ObjectSlotProps, Slots } from './getSlots';
 
 /**
  * Similar to `getSlots`, main difference is that it's compatible with new custom jsx pragma
+ *
+ * @internal
+ * This is an internal temporary method, this method will cease to exist eventually!
+ *
+ * * ❗️❗️ **DO NOT USE IT EXTERNALLY** ❗️❗️
  */
 export function getSlotsNext<R extends SlotPropsRecord>(
   state: ComponentState<R>,