docs: finish section for SearchBox

coder · Parkreiner · Mar 11, 2024 · Mar 4, 2024 · Mar 4, 2024 · Mar 4, 2024
commit f3a8daee97402301355fbc7ebbb9112d9a5e4546
diff --git a/plugins/backstage-plugin-coder/docs/api-reference/components.md b/plugins/backstage-plugin-coder/docs/api-reference/components.md
@@ -414,12 +414,34 @@ All props mirror those returned by [`useWorkspacesCardContext`](./hooks.md#usewo
 
 ## `CoderWorkspacesCard.SearchBox`
898F
 
+Provides the core search functionality for Coder workspaces.
+
 ### Type definition
 
+```tsx
+type Props = {
+  searchInputRef?: ForwardedRef<HTMLInputElement>;
+  clearButtonRef?: ForwardedRef<HTMLButtonElement>;
+
+  labelWrapperClassName?: string;
+  clearButtonClassName?: string;
+  searchInputClassName?: string;
+
+  // Also supports all props from the native HTMLFieldSetElement
+  // component, except "children" and "aria-labelledby"
+};
+
+declare function SearchBox(props: Props): JSX.Element;
+```
+
 ### Throws
 
+- Will throw a render error if called outside of either a `CoderProvider` or `CoderWorkspacesCard.Root`
+
 ### Notes
 
+- The logic for processing user input into a new workspaces query is automatically debounced to wait 400ms.
+
 ## `CoderWorkspacesCard.WorkspacesList`
 
 ### Type definition