wip

sanity-io · Aug 10, 2023 · 1ef9af1 · 1ef9af1
1 parent 3350f0d
commit 1ef9af1
Show file tree

Hide file tree

Showing 6 changed files with 392 additions and 30 deletions.
diff --git a/packages/@sanity/portable-text-editor/src/editor/PortableTextEditor.tsx b/packages/@sanity/portable-text-editor/src/editor/PortableTextEditor.tsx
@@ -29,11 +29,6 @@ import {Synchronizer} from './components/Synchronizer'
 
 const debug = debugWithName('component:PortableTextEditor')
 
-/**
- * Props for the PortableTextEditor component
- *
- * @public
- */
 /**
  * Props for the PortableTextEditor component
  *

diff --git a/packages/sanity/src/core/form/inputs/PortableText/PortableTextInput.tsx b/packages/sanity/src/core/form/inputs/PortableText/PortableTextInput.tsx
@@ -45,10 +45,16 @@ export interface PortableTextMemberItem {
 }
 
 /**
- * The root Portable Text Input component
+ * Input component for editing block content
+ * ({@link https://github.com/portabletext/portabletext | Portable Text}) in the Sanity Studio.
+ *
+ * Supports multi-user real-time block content editing on larger documents.
+ *
+ * This component can be configured and customized extensively.
+ * {@link https://www.sanity.io/docs/portable-text-features | Go to the documentation for more details}.
  *
- * @hidden
  * @beta
+ * @param props - {@link PortableTextInputProps} component props. Extends {@link ArrayOfObjectsInputProps}.
  */
 export function PortableTextInput(props: PortableTextInputProps) {
   const {

diff --git a/packages/sanity/src/core/form/types/_transitional.ts b/packages/sanity/src/core/form/types/_transitional.ts
@@ -24,9 +24,10 @@ export type RenderCustomMarkers = (markers: PortableTextMarker[]) => React.React
 /**
  * A generic marker for attaching metadata to specific nodes of the Portable Text input.
  *
- *
- * @hidden
  * @beta
+ * @param type - a type name for this marker
+ * @param data - some data connected to this marker
+ * @param path - the path to the Portable Text content connected to this marker
  */
 export interface PortableTextMarker {
   type: string