@geenius/docs 0.4.1 → 0.8.10

package/packages/solidjs-css/dist/index.d.ts

@@ -96,6 +96,7 @@ interface DocsLayoutProps {
     sections: (DocSection & {
         pages?: DocPage$1[];
     })[];
+    currentPage?: DocPage$1;
     toc?: TocItem[];
     activeHeadingId?: string;
     breadcrumbs?: BreadcrumbItem[];
@@ -359,6 +360,15 @@ declare function DocViewPage(props: DocViewPageProps): JSX.Element;
  * variant so modal and page-level search flows share the same behavior.
  */
 
+/**
+ * Search state returned by the SolidJS CSS docs search primitive.
+ *
+ * @property results - Accessor returning the current ranked search results.
+ * @property isSearching - Accessor describing whether a search request is pending.
+ * @property query - Accessor returning the active search query.
+ * @property setQuery - Updates the active search query.
+ * @property clearSearch - Resets the query, results, and loading state.
+ */
 interface DocSearchState {
     results: Accessor<SearchResult[]>;
     isSearching: Accessor<boolean>;
@@ -382,6 +392,20 @@ declare function createDocSearch(searchFn: (query: string) => SearchResult[] | P
  * Tailwind SolidJS surface while staying local to the CSS package.
  */
 
+/**
+ * Aggregate docs state returned by the SolidJS CSS docs primitive.
+ *
+ * @property sections - Accessor returning the normalized docs sections.
+ * @property currentSection - Accessor for the currently selected section.
+ * @property setSection - Updates the selected section and resets the page selection.
+ * @property currentPage - Accessor for the currently selected page.
+ * @property setPage - Updates the selected page.
+ * @property searchQuery - Accessor for the active docs search query.
+ * @property setSearchQuery - Updates the active docs search query.
+ * @property isLoading - Accessor describing whether the tree is still unresolved.
+ * @property config - Accessor returning the merged docs configuration.
+ * @property flatPages - Accessor returning the flattened page list.
+ */
 interface DocsState {
     sections: Accessor<(DocSection & {
         pages: DocPage$1[];
@@ -416,6 +440,13 @@ declare function createDocs(tree: Accessor<(DocSection & {
  * SolidJS CSS docs variant.
  */
 
+/**
+ * Table-of-contents state returned by the SolidJS CSS docs TOC primitive.
+ *
+ * @property toc - Accessor returning the extracted heading tree.
+ * @property activeId - Accessor returning the currently active heading id.
+ * @property setActiveId - Updates the currently active heading id.
+ */
 interface TableOfContentsState {
     toc: Accessor<TocItem[]>;
     activeId: Accessor<string>;