@consilioweb/admin-nav 0.4.3

package/dist/client.d.cts

@@ -0,0 +1,147 @@
+import React from 'react';
+import * as payload from 'payload';
+import * as _payloadcms_translations from '@payloadcms/translations';
+
+/**
+ * AdminNav — The main sidebar navigation component.
+ * Replaces the default Payload admin nav with the plugin's customizable navigation.
+ * Reads per-user preferences from the API, falls back to the defaultNav config.
+ */
+declare const AdminNav: React.FC;
+
+/**
+ * NavCustomizer — Full drag & drop navigation editor.
+ * Allows reordering groups and items, toggling visibility,
+ * editing labels/icons/URLs, creating new groups/items.
+ */
+declare const NavCustomizer: React.FC;
+
+/** Localizable string — plain string or per-language record */
+type LocalizedString = string | Record<string, string>;
+/** A single navigation item */
+interface NavItemConfig {
+    /** Unique item ID (e.g. 'pages', 'posts', 'seo-dashboard') */
+    id: string;
+    /** Admin URL path (e.g. '/admin/collections/pages') */
+    href: string;
+    /** Display label (string or { fr: '...', en: '...' }) */
+    label: LocalizedString;
+    /** Icon name from the built-in icon registry */
+    icon: string;
+    /** If true, pathname.startsWith(href) activates the item */
+    matchPrefix?: boolean;
+    /** Nested child items (e.g. ticket status filters) */
+    children?: NavItemConfig[];
+    /** Whether this item is visible (default: true) */
+    visible?: boolean;
+}
+/** A navigation group (section with a title) */
+interface NavGroupConfig {
+    /** Unique group ID */
+    id: string;
+    /** Group title displayed as section header (string or { fr: '...', en: '...' }) */
+    title: LocalizedString;
+    /** Items in this group */
+    items: NavItemConfig[];
+    /** Whether this group is visible (default: true) */
+    visible?: boolean;
+    /** Whether this group starts collapsed (default: false) */
+    defaultCollapsed?: boolean;
+}
+
+interface SortableGroupProps {
+    group: NavGroupConfig;
+    children: React.ReactNode;
+    onToggleVisibility: (groupId: string) => void;
+    onEdit: (group: NavGroupConfig) => void;
+    onDelete: (groupId: string) => void;
+}
+declare const SortableGroup: React.FC<SortableGroupProps>;
+
+interface SortableItemProps {
+    item: NavItemConfig;
+    groupId: string;
+    onToggleVisibility: (groupId: string, itemId: string) => void;
+    onEdit: (item: NavItemConfig, groupId: string) => void;
+    onDelete: (groupId: string, itemId: string) => void;
+}
+declare const SortableItem: React.FC<SortableItemProps>;
+
+interface GroupEditorProps {
+    group?: NavGroupConfig;
+    onSave: (group: NavGroupConfig) => void;
+    onCancel: () => void;
+}
+declare const GroupEditor: React.FC<GroupEditorProps>;
+
+interface NavItemEditorProps {
+    item: NavItemConfig;
+    onSave: (item: NavItemConfig) => void;
+    onCancel: () => void;
+}
+declare const NavItemEditor: React.FC<NavItemEditorProps>;
+
+interface IconPickerProps {
+    value: string;
+    onChange: (icon: string) => void;
+    onClose: () => void;
+}
+declare const IconPicker: React.FC<IconPickerProps>;
+
+interface UseNavPreferencesReturn {
+    /** Current nav layout (user's custom or default) */
+    layout: NavGroupConfig[];
+    /** Whether the layout is loaded */
+    isLoaded: boolean;
+    /** Whether a save/reset operation is in progress */
+    isSaving: boolean;
+    /** Whether the current layout differs from default */
+    isCustom: boolean;
+    /** Save the current layout to the server */
+    save: (groups: NavGroupConfig[]) => Promise<boolean>;
+    /** Reset to default layout */
+    reset: () => Promise<boolean>;
+    /** Reload preferences from server */
+    reload: () => Promise<void>;
+}
+/**
+ * Hook to fetch, save, and reset nav preferences for the current user.
+ * Falls back to the default nav from the plugin config endpoint.
+ *
+ * Uses a two-tier cache for instant rendering:
+ * 1. Module-level variables — survive component re-mounts during SPA
+ *    navigation (the common case). Available immediately in useState.
+ * 2. sessionStorage — survives full page reloads. Read in useEffect
+ *    (post-hydration) to avoid React hydration mismatch #418.
+ *
+ * On the server, module vars are null → layout=[] → matches client
+ * first render. After the first fetch, module vars are populated →
+ * subsequent mounts get instant data (no flash).
+ */
+declare function useNavPreferences(basePath?: string): UseNavPreferencesReturn;
+
+/** All translation keys for the plugin-admin-nav namespace */
+type PluginAdminNavTranslationKeys = 'plugin-admin-nav:save' | 'plugin-admin-nav:cancel' | 'plugin-admin-nav:reset' | 'plugin-admin-nav:create' | 'plugin-admin-nav:ok' | 'plugin-admin-nav:close' | 'plugin-admin-nav:show' | 'plugin-admin-nav:hide' | 'plugin-admin-nav:edit' | 'plugin-admin-nav:delete' | 'plugin-admin-nav:addItem' | 'plugin-admin-nav:addGroup' | 'plugin-admin-nav:addSubmenu' | 'plugin-admin-nav:moveUp' | 'plugin-admin-nav:moveDown' | 'plugin-admin-nav:labelField' | 'plugin-admin-nav:urlField' | 'plugin-admin-nav:iconField' | 'plugin-admin-nav:titleField' | 'plugin-admin-nav:idField' | 'plugin-admin-nav:editItem' | 'plugin-admin-nav:editGroup' | 'plugin-admin-nav:newGroup' | 'plugin-admin-nav:customizeTitle' | 'plugin-admin-nav:loading' | 'plugin-admin-nav:saving' | 'plugin-admin-nav:savedSuccess' | 'plugin-admin-nav:saveError' | 'plugin-admin-nav:resetSuccess' | 'plugin-admin-nav:resetError' | 'plugin-admin-nav:dndHint' | 'plugin-admin-nav:deleteGroupConfirm' | 'plugin-admin-nav:resetConfirm' | 'plugin-admin-nav:submenus' | 'plugin-admin-nav:noSubmenus' | 'plugin-admin-nav:noLabel' | 'plugin-admin-nav:newLink' | 'plugin-admin-nav:dashboard' | 'plugin-admin-nav:customize' | 'plugin-admin-nav:matchPrefix' | 'plugin-admin-nav:defaultCollapsed' | 'plugin-admin-nav:searchIcon' | 'plugin-admin-nav:dotColor' | 'plugin-admin-nav:noIconFound' | 'plugin-admin-nav:multiLang' | 'plugin-admin-nav:titlePlaceholder' | 'plugin-admin-nav:idPlaceholder' | 'plugin-admin-nav:childLabelPlaceholder' | 'plugin-admin-nav:childUrlPlaceholder' | 'plugin-admin-nav:childIconPlaceholder' | 'plugin-admin-nav:childIconLabel';
+
+/**
+ * Typed wrapper around Payload's useTranslation that includes
+ * the plugin-admin-nav translation keys.
+ */
+declare const usePluginTranslation: () => {
+    i18n: _payloadcms_translations.I18nClient<Record<string, never>, PluginAdminNavTranslationKeys>;
+    languageOptions: payload.LanguageOptions;
+    switchLanguage?: (lang: _payloadcms_translations.AcceptedLanguages) => Promise<void>;
+    t: _payloadcms_translations.TFunction<PluginAdminNavTranslationKeys | "authentication:account" | "authentication:accountOfCurrentUser" | "authentication:accountVerified" | "authentication:alreadyActivated" | "authentication:alreadyLoggedIn" | "authentication:apiKey" | "authentication:authenticated" | "authentication:backToLogin" | "authentication:beginCreateFirstUser" | "authentication:changePassword" | "authentication:checkYourEmailForPasswordReset" | "authentication:confirmGeneration" | "authentication:confirmPassword" | "authentication:createFirstUser" | "authentication:emailNotValid" | "authentication:emailOrUsername" | "authentication:emailSent" | "authentication:emailVerified" | "authentication:enableAPIKey" | "authentication:failedToUnlock" | "authentication:forceUnlock" | "authentication:forgotPassword" | "authentication:forgotPasswordEmailInstructions" | "authentication:forgotPasswordUsernameInstructions" | "authentication:usernameNotValid" | "authentication:forgotPasswordQuestion" | "authentication:generate" | "authentication:generateNewAPIKey" | "authentication:generatingNewAPIKeyWillInvalidate" | "authentication:logBackIn" | "authentication:loggedIn" | "authentication:loggedInChangePassword" | "authentication:loggedOutInactivity" | "authentication:loggedOutSuccessfully" | "authentication:loggingOut" | "authentication:login" | "authentication:logOut" | "authentication:logout" | "authentication:logoutSuccessful" | "authentication:logoutUser" | "authentication:newAPIKeyGenerated" | "authentication:newPassword" | "authentication:passed" | "authentication:passwordResetSuccessfully" | "authentication:resetPassword" | "authentication:stayLoggedIn" | "authentication:successfullyRegisteredFirstUser" | "authentication:successfullyUnlocked" | "authentication:tokenRefreshSuccessful" | "authentication:unableToVerify" | "authentication:username" | "authentication:verified" | "authentication:verifiedSuccessfully" | "authentication:verify" | "authentication:verifyUser" | "authentication:youAreInactive" | "dashboard:addWidget" | "dashboard:deleteWidget" | "dashboard:searchWidgets" | "error:autosaving" | "error:correctInvalidFields" | "error:deletingTitle" | "error:documentNotFound" | "error:emailOrPasswordIncorrect" | "error:insufficientClipboardPermissions" | "error:invalidClipboardData" | "error:invalidFileType" | "error:invalidRequestArgs" | "error:loadingDocument" | "error:logoutFailed" | "error:noMatchedField" | "error:notAllowedToAccessPage" | "error:notAllowedToPerformAction" | "error:previewing" | "error:problemUploadingFile" | "error:restoringTitle" | "error:revertingDocument" | "error:tokenNotProvided" | "error:unableToCopy" | "error:unableToDeleteCount" | "error:unableToReindexCollection" | "error:unableToUpdateCount" | "error:unauthorized" | "error:unauthorizedAdmin" | "error:unknown" | "error:unPublishingDocument" | "error:unspecific" | "error:unverifiedEmail" | "error:userEmailAlreadyRegistered" | "error:usernameAlreadyRegistered" | "error:usernameOrPasswordIncorrect" | "fields:blocks" | "fields:addLabel" | "fields:addLink" | "fields:addNew" | "fields:addNewLabel" | "fields:addRelationship" | "fields:addUpload" | "fields:block" | "fields:blockType" | "fields:chooseBetweenCustomTextOrDocument" | "fields:chooseDocumentToLink" | "fields:chooseFromExisting" | "fields:collapseAll" | "fields:customURL" | "fields:editLink" | "fields:editRelationship" | "fields:enterURL" | "fields:internalLink" | "fields:itemsAndMore" | "fields:labelRelationship" | "fields:latitude" | "fields:linkedTo" | "fields:linkType" | "fields:longitude" | "fields:openInNewTab" | "fields:passwordsDoNotMatch" | "fields:removeRelationship" | "fields:removeUpload" | "fields:saveChanges" | "fields:searchForBlock" | "fields:searchForLanguage" | "fields:selectFieldsToEdit" | "fields:showAll" | "fields:swapRelationship" | "fields:swapUpload" | "fields:textToDisplay" | "fields:toggleBlock" | "fields:uploadNewLabel" | "folder:browseByFolder" | "folder:byFolder" | "folder:deleteFolder" | "folder:folderName" | "folder:folders" | "folder:folderTypeDescription" | "folder:itemHasBeenMoved" | "folder:itemHasBeenMovedToRoot" | "folder:itemsMovedToFolder" | "folder:itemsMovedToRoot" | "folder:moveFolder" | "folder:moveItemsToFolderConfirmation" | "folder:moveItemsToRootConfirmation" | "folder:moveItemToFolderConfirmation" | "folder:moveItemToRootConfirmation" | "folder:movingFromFolder" | "folder:newFolder" | "folder:noFolder" | "folder:renameFolder" | "folder:searchByNameInFolder" | "folder:selectFolderForItem" | "general:items" | "general:of" | "general:language" | "general:dashboard" | "general:error" | "general:username" | "general:notFound" | "general:unauthorized" | "general:newLabel" | "general:saveChanges" | "general:name" | "general:aboutToDelete" | "general:aboutToPermanentlyDelete" | "general:aboutToPermanentlyDeleteTrash" | "general:aboutToRestore" | "general:aboutToRestoreAsDraft" | "general:aboutToRestoreAsDraftCount" | "general:aboutToRestoreCount" | "general:aboutToTrash" | "general:aboutToTrashCount" | "general:addBelow" | "general:addFilter" | "general:adminTheme" | "general:all" | "general:allCollections" | "general:allLocales" | "general:and" | "general:anotherUser" | "general:anotherUserTakenOver" | "general:applyChanges" | "general:ascending" | "general:automatic" | "general:backToDashboard" | "general:cancel" | "general:changesNotSaved" | "general:clear" | "general:clearAll" | "general:close" | "general:collapse" | "general:collections" | "general:columns" | "general:columnToSort" | "general:confirm" | "general:confirmCopy" | "general:confirmDeletion" | "general:confirmDuplication" | "general:confirmMove" | "general:confirmReindex" | "general:confirmReindexAll" | "general:confirmReindexDescription" | "general:confirmReindexDescriptionAll" | "general:confirmRestoration" | "general:copied" | "general:copy" | "general:copyField" | "general:copying" | "general:copyRow" | "general:copyWarning" | "general:create" | "general:created" | "general:createdAt" | "general:createNew" | "general:createNewLabel" | "general:creating" | "general:creatingNewLabel" | "general:currentlyEditing" | "general:custom" | "general:dark" | "general:delete" | "general:deleted" | "general:deletedAt" | "general:deletedCountSuccessfully" | "general:deletedSuccessfully" | "general:deleteLabel" | "general:deletePermanently" | "general:deleting" | "general:depth" | "general:descending" | "general:deselectAllRows" | "general:document" | "general:documentIsTrashed" | "general:documentLocked" | "general:documents" | "general:duplicate" | "general:duplicateWithoutSaving" | "general:edit" | "general:editAll" | "general:editedSince" | "general:editing" | "general:editingTakenOver" | "general:editLabel" | "general:email" | "general:emailAddress" | "general:emptyTrash" | "general:emptyTrashLabel" | "general:enterAValue" | "general:errors" | "general:exitLivePreview" | "general:export" | "general:fallbackToDefaultLocale" | "general:false" | "general:filters" | "general:filterWhere" | "general:globals" | "general:goBack" | "general:groupByLabel" | "general:import" | "general:isEditing" | "general:item" | "general:lastModified" | "general:layout" | "general:leaveAnyway" | "general:leaveWithoutSaving" | "general:light" | "general:livePreview" | "general:loading" | "general:locale" | "general:locales" | "general:lock" | "general:menu" | "general:moreOptions" | "general:move" | "general:moveConfirm" | "general:moveCount" | "general:moveDown" | "general:moveUp" | "general:moving" | "general:movingCount" | "general:next" | "general:no" | "general:noDateSelected" | "general:noFiltersSet" | "general:noLabel" | "general:none" | "general:noOptions" | "general:noResults" | "general:noResultsDescription" | "general:noResultsFound" | "general:nothingFound" | "general:noTrashResults" | "general:noUpcomingEventsScheduled" | "general:noValue" | "general:only" | "general:open" | "general:or" | "general:order" | "general:overwriteExistingData" | "general:pageNotFound" | "general:password" | "general:pasteField" | "general:pasteRow" | "general:payloadSettings" | "general:permanentlyDelete" | "general:permanentlyDeletedCountSuccessfully" | "general:perPage" | "general:previous" | "general:reindex" | "general:reindexingAll" | "general:remove" | "general:rename" | "general:reset" | "general:resetPreferences" | "general:resetPreferencesDescription" | "general:resettingPreferences" | "general:restore" | "general:restoreAsPublished" | "general:restoredCountSuccessfully" | "general:restoring" | "general:row" | "general:rows" | "general:save" | "general:saving" | "general:schedulePublishFor" | "general:searchBy" | "general:select" | "general:selectAll" | "general:selectAllRows" | "general:selectedCount" | "general:selectLabel" | "general:selectValue" | "general:showAllLabel" | "general:sorryNotFound" | "general:sort" | "general:sortByLabelDirection" | "general:stayOnThisPage" | "general:submissionSuccessful" | "general:submit" | "general:submitting" | "general:success" | "general:successfullyCreated" | "general:successfullyDuplicated" | "general:successfullyReindexed" | "general:takeOver" | "general:thisLanguage" | "general:time" | "general:timezone" | "general:titleDeleted" | "general:titleRestored" | "general:titleTrashed" | "general:trash" | "general:trashedCountSuccessfully" | "general:true" | "general:unlock" | "general:unsavedChanges" | "general:unsavedChangesDuplicate" | "general:untitled" | "general:upcomingEvents" | "general:updatedAt" | "general:updatedCountSuccessfully" | "general:updatedLabelSuccessfully" | "general:updatedSuccessfully" | "general:updateForEveryone" | "general:updating" | "general:uploading" | "general:uploadingBulk" | "general:user" | "general:users" | "general:value" | "general:viewing" | "general:viewReadOnly" | "general:welcome" | "general:yes" | "localization:cannotCopySameLocale" | "localization:copyFrom" | "localization:copyFromTo" | "localization:copyTo" | "localization:copyToLocale" | "localization:localeToPublish" | "localization:selectedLocales" | "localization:selectLocaleToCopy" | "localization:selectLocaleToDuplicate" | "operators:contains" | "operators:equals" | "operators:exists" | "operators:intersects" | "operators:near" | "operators:within" | "operators:isGreaterThan" | "operators:isGreaterThanOrEqualTo" | "operators:isIn" | "operators:isLessThan" | "operators:isLessThanOrEqualTo" | "operators:isLike" | "operators:isNotEqualTo" | "operators:isNotIn" | "operators:isNotLike" | "upload:addFile" | "upload:addFiles" | "upload:bulkUpload" | "upload:crop" | "upload:cropToolDescription" | "upload:download" | "upload:dragAndDrop" | "upload:editImage" | "upload:fileName" | "upload:fileSize" | "upload:filesToUpload" | "upload:fileToUpload" | "upload:focalPoint" | "upload:focalPointDescription" | "upload:height" | "upload:noFile" | "upload:pasteURL" | "upload:previewSizes" | "upload:selectCollectionToBrowse" | "upload:selectFile" | "upload:setCropArea" | "upload:setFocalPoint" | "upload:sizes" | "upload:sizesFor" | "upload:width" | "validation:username" | "validation:emailAddress" | "validation:enterNumber" | "validation:fieldHasNo" | "validation:greaterThanMax" | "validation:invalidBlock" | "validation:invalidBlocks" | "validation:invalidInput" | "validation:invalidSelection" | "validation:invalidSelections" | "validation:latitudeOutOfBounds" | "validation:lessThanMin" | "validation:limitReached" | "validation:longerThanMin" | "validation:longitudeOutOfBounds" | "validation:notValidDate" | "validation:required" | "validation:requiresAtLeast" | "validation:requiresNoMoreThan" | "validation:requiresTwoNumbers" | "validation:shorterThanMax" | "validation:timezoneRequired" | "validation:trueOrFalse" | "validation:validUploadID" | "version:version" | "version:aboutToRestore" | "version:restoring" | "version:type" | "version:aboutToPublishSelection" | "version:aboutToRestoreGlobal" | "version:aboutToRevertToPublished" | "version:aboutToUnpublish" | "version:aboutToUnpublishIn" | "version:aboutToUnpublishSelection" | "version:autosave" | "version:autosavedSuccessfully" | "version:autosavedVersion" | "version:changed" | "version:compareVersions" | "version:comparingAgainst" | "version:confirmPublish" | "version:confirmRevertToSaved" | "version:confirmUnpublish" | "version:confirmVersionRestoration" | "version:currentDraft" | "version:currentlyPublished" | "version:currentlyViewing" | "version:currentPublishedVersion" | "version:draft" | "version:draftHasPublishedVersion" | "version:draftSavedSuccessfully" | "version:lastSavedAgo" | "version:modifiedOnly" | "version:moreVersions" | "version:noFurtherVersionsFound" | "version:noLabelGroup" | "version:noRowsFound" | "version:noRowsSelected" | "version:preview" | "version:previouslyDraft" | "version:previouslyPublished" | "version:previousVersion" | "version:problemRestoringVersion" | "version:publish" | "version:publishAllLocales" | "version:publishChanges" | "version:published" | "version:publishIn" | "version:publishing" | "version:restoreAsDraft" | "version:restoredSuccessfully" | "version:restoreThisVersion" | "version:reverting" | "version:revertToPublished" | "version:revertUnsuccessful" | "version:saveDraft" | "version:scheduledSuccessfully" | "version:schedulePublish" | "version:selectLocales" | "version:selectVersionToCompare" | "version:showLocales" | "version:specificVersion" | "version:status" | "version:unpublish" | "version:unpublished" | "version:unpublishedSuccessfully" | "version:unpublishIn" | "version:unpublishing" | "version:versionAgo" | "version:versionID" | "version:versions" | "version:viewingVersion" | "version:viewingVersionGlobal" | "version:viewingVersions" | "version:viewingVersionsGlobal" | "general:aboutToDeleteCount" | "general:editingLabel" | "version:changedFieldsCount">;
+};
+
+/**
+ * Check if a label is a multi-language record.
+ */
+declare function isMultiLang(label: string | Record<string, string>): label is Record<string, string>;
+/**
+ * Resolve a potentially multi-language label to a string.
+ * Falls back to: lang → fallback → first available value → empty string.
+ */
+declare function resolveLabel(label: string | Record<string, string>, lang: string, fallback?: string): string;
+
+export { AdminNav, GroupEditor, IconPicker, NavCustomizer, NavItemEditor, type PluginAdminNavTranslationKeys, SortableGroup, SortableItem, isMultiLang, resolveLabel, useNavPreferences, usePluginTranslation };

package/dist/client.d.ts

@@ -0,0 +1,147 @@
+import React from 'react';
+import * as payload from 'payload';
+import * as _payloadcms_translations from '@payloadcms/translations';
+
+/**
+ * AdminNav — The main sidebar navigation component.
+ * Replaces the default Payload admin nav with the plugin's customizable navigation.
+ * Reads per-user preferences from the API, falls back to the defaultNav config.
+ */
+declare const AdminNav: React.FC;
+
+/**
+ * NavCustomizer — Full drag & drop navigation editor.
+ * Allows reordering groups and items, toggling visibility,
+ * editing labels/icons/URLs, creating new groups/items.
+ */
+declare const NavCustomizer: React.FC;
+
+/** Localizable string — plain string or per-language record */
+type LocalizedString = string | Record<string, string>;
+/** A single navigation item */
+interface NavItemConfig {
+    /** Unique item ID (e.g. 'pages', 'posts', 'seo-dashboard') */
+    id: string;
+    /** Admin URL path (e.g. '/admin/collections/pages') */
+    href: string;
+    /** Display label (string or { fr: '...', en: '...' }) */
+    label: LocalizedString;
+    /** Icon name from the built-in icon registry */
+    icon: string;
+    /** If true, pathname.startsWith(href) activates the item */
+    matchPrefix?: boolean;
+    /** Nested child items (e.g. ticket status filters) */
+    children?: NavItemConfig[];
+    /** Whether this item is visible (default: true) */
+    visible?: boolean;
+}
+/** A navigation group (section with a title) */
+interface NavGroupConfig {
+    /** Unique group ID */
+    id: string;
+    /** Group title displayed as section header (string or { fr: '...', en: '...' }) */
+    title: LocalizedString;
+    /** Items in this group */
+    items: NavItemConfig[];
+    /** Whether this group is visible (default: true) */
+    visible?: boolean;
+    /** Whether this group starts collapsed (default: false) */
+    defaultCollapsed?: boolean;
+}
+
+interface SortableGroupProps {
+    group: NavGroupConfig;
+    children: React.ReactNode;
+    onToggleVisibility: (groupId: string) => void;
+    onEdit: (group: NavGroupConfig) => void;
+    onDelete: (groupId: string) => void;
+}
+declare const SortableGroup: React.FC<SortableGroupProps>;
+
+interface SortableItemProps {
+    item: NavItemConfig;
+    groupId: string;
+    onToggleVisibility: (groupId: string, itemId: string) => void;
+    onEdit: (item: NavItemConfig, groupId: string) => void;
+    onDelete: (groupId: string, itemId: string) => void;
+}
+declare const SortableItem: React.FC<SortableItemProps>;
+
+interface GroupEditorProps {
+    group?: NavGroupConfig;
+    onSave: (group: NavGroupConfig) => void;
+    onCancel: () => void;
+}
+declare const GroupEditor: React.FC<GroupEditorProps>;
+
+interface NavItemEditorProps {
+    item: NavItemConfig;
+    onSave: (item: NavItemConfig) => void;
+    onCancel: () => void;
+}
+declare const NavItemEditor: React.FC<NavItemEditorProps>;
+
+interface IconPickerProps {
+    value: string;
+    onChange: (icon: string) => void;
+    onClose: () => void;
+}
+declare const IconPicker: React.FC<IconPickerProps>;
+
+interface UseNavPreferencesReturn {
+    /** Current nav layout (user's custom or default) */
+    layout: NavGroupConfig[];
+    /** Whether the layout is loaded */
+    isLoaded: boolean;
+    /** Whether a save/reset operation is in progress */
+    isSaving: boolean;
+    /** Whether the current layout differs from default */
+    isCustom: boolean;
+    /** Save the current layout to the server */
+    save: (groups: NavGroupConfig[]) => Promise<boolean>;
+    /** Reset to default layout */
+    reset: () => Promise<boolean>;
+    /** Reload preferences from server */
+    reload: () => Promise<void>;
+}
+/**
+ * Hook to fetch, save, and reset nav preferences for the current user.
+ * Falls back to the default nav from the plugin config endpoint.
+ *
+ * Uses a two-tier cache for instant rendering:
+ * 1. Module-level variables — survive component re-mounts during SPA
+ *    navigation (the common case). Available immediately in useState.
+ * 2. sessionStorage — survives full page reloads. Read in useEffect
+ *    (post-hydration) to avoid React hydration mismatch #418.
+ *
+ * On the server, module vars are null → layout=[] → matches client
+ * first render. After the first fetch, module vars are populated →
+ * subsequent mounts get instant data (no flash).
+ */
+declare function useNavPreferences(basePath?: string): UseNavPreferencesReturn;
+
+/** All translation keys for the plugin-admin-nav namespace */
+type PluginAdminNavTranslationKeys = 'plugin-admin-nav:save' | 'plugin-admin-nav:cancel' | 'plugin-admin-nav:reset' | 'plugin-admin-nav:create' | 'plugin-admin-nav:ok' | 'plugin-admin-nav:close' | 'plugin-admin-nav:show' | 'plugin-admin-nav:hide' | 'plugin-admin-nav:edit' | 'plugin-admin-nav:delete' | 'plugin-admin-nav:addItem' | 'plugin-admin-nav:addGroup' | 'plugin-admin-nav:addSubmenu' | 'plugin-admin-nav:moveUp' | 'plugin-admin-nav:moveDown' | 'plugin-admin-nav:labelField' | 'plugin-admin-nav:urlField' | 'plugin-admin-nav:iconField' | 'plugin-admin-nav:titleField' | 'plugin-admin-nav:idField' | 'plugin-admin-nav:editItem' | 'plugin-admin-nav:editGroup' | 'plugin-admin-nav:newGroup' | 'plugin-admin-nav:customizeTitle' | 'plugin-admin-nav:loading' | 'plugin-admin-nav:saving' | 'plugin-admin-nav:savedSuccess' | 'plugin-admin-nav:saveError' | 'plugin-admin-nav:resetSuccess' | 'plugin-admin-nav:resetError' | 'plugin-admin-nav:dndHint' | 'plugin-admin-nav:deleteGroupConfirm' | 'plugin-admin-nav:resetConfirm' | 'plugin-admin-nav:submenus' | 'plugin-admin-nav:noSubmenus' | 'plugin-admin-nav:noLabel' | 'plugin-admin-nav:newLink' | 'plugin-admin-nav:dashboard' | 'plugin-admin-nav:customize' | 'plugin-admin-nav:matchPrefix' | 'plugin-admin-nav:defaultCollapsed' | 'plugin-admin-nav:searchIcon' | 'plugin-admin-nav:dotColor' | 'plugin-admin-nav:noIconFound' | 'plugin-admin-nav:multiLang' | 'plugin-admin-nav:titlePlaceholder' | 'plugin-admin-nav:idPlaceholder' | 'plugin-admin-nav:childLabelPlaceholder' | 'plugin-admin-nav:childUrlPlaceholder' | 'plugin-admin-nav:childIconPlaceholder' | 'plugin-admin-nav:childIconLabel';
+
+/**
+ * Typed wrapper around Payload's useTranslation that includes
+ * the plugin-admin-nav translation keys.
+ */
+declare const usePluginTranslation: () => {
+    i18n: _payloadcms_translations.I18nClient<Record<string, never>, PluginAdminNavTranslationKeys>;
+    languageOptions: payload.LanguageOptions;
+    switchLanguage?: (lang: _payloadcms_translations.AcceptedLanguages) => Promise<void>;
+    t: _payloadcms_translations.TFunction<PluginAdminNavTranslationKeys | "authentication:account" | "authentication:accountOfCurrentUser" | "authentication:accountVerified" | "authentication:alreadyActivated" | "authentication:alreadyLoggedIn" | "authentication:apiKey" | "authentication:authenticated" | "authentication:backToLogin" | "authentication:beginCreateFirstUser" | "authentication:changePassword" | "authentication:checkYourEmailForPasswordReset" | "authentication:confirmGeneration" | "authentication:confirmPassword" | "authentication:createFirstUser" | "authentication:emailNotValid" | "authentication:emailOrUsername" | "authentication:emailSent" | "authentication:emailVerified" | "authentication:enableAPIKey" | "authentication:failedToUnlock" | "authentication:forceUnlock" | "authentication:forgotPassword" | "authentication:forgotPasswordEmailInstructions" | "authentication:forgotPasswordUsernameInstructions" | "authentication:usernameNotValid" | "authentication:forgotPasswordQuestion" | "authentication:generate" | "authentication:generateNewAPIKey" | "authentication:generatingNewAPIKeyWillInvalidate" | "authentication:logBackIn" | "authentication:loggedIn" | "authentication:loggedInChangePassword" | "authentication:loggedOutInactivity" | "authentication:loggedOutSuccessfully" | "authentication:loggingOut" | "authentication:login" | "authentication:logOut" | "authentication:logout" | "authentication:logoutSuccessful" | "authentication:logoutUser" | "authentication:newAPIKeyGenerated" | "authentication:newPassword" | "authentication:passed" | "authentication:passwordResetSuccessfully" | "authentication:resetPassword" | "authentication:stayLoggedIn" | "authentication:successfullyRegisteredFirstUser" | "authentication:successfullyUnlocked" | "authentication:tokenRefreshSuccessful" | "authentication:unableToVerify" | "authentication:username" | "authentication:verified" | "authentication:verifiedSuccessfully" | "authentication:verify" | "authentication:verifyUser" | "authentication:youAreInactive" | "dashboard:addWidget" | "dashboard:deleteWidget" | "dashboard:searchWidgets" | "error:autosaving" | "error:correctInvalidFields" | "error:deletingTitle" | "error:documentNotFound" | "error:emailOrPasswordIncorrect" | "error:insufficientClipboardPermissions" | "error:invalidClipboardData" | "error:invalidFileType" | "error:invalidRequestArgs" | "error:loadingDocument" | "error:logoutFailed" | "error:noMatchedField" | "error:notAllowedToAccessPage" | "error:notAllowedToPerformAction" | "error:previewing" | "error:problemUploadingFile" | "error:restoringTitle" | "error:revertingDocument" | "error:tokenNotProvided" | "error:unableToCopy" | "error:unableToDeleteCount" | "error:unableToReindexCollection" | "error:unableToUpdateCount" | "error:unauthorized" | "error:unauthorizedAdmin" | "error:unknown" | "error:unPublishingDocument" | "error:unspecific" | "error:unverifiedEmail" | "error:userEmailAlreadyRegistered" | "error:usernameAlreadyRegistered" | "error:usernameOrPasswordIncorrect" | "fields:blocks" | "fields:addLabel" | "fields:addLink" | "fields:addNew" | "fields:addNewLabel" | "fields:addRelationship" | "fields:addUpload" | "fields:block" | "fields:blockType" | "fields:chooseBetweenCustomTextOrDocument" | "fields:chooseDocumentToLink" | "fields:chooseFromExisting" | "fields:collapseAll" | "fields:customURL" | "fields:editLink" | "fields:editRelationship" | "fields:enterURL" | "fields:internalLink" | "fields:itemsAndMore" | "fields:labelRelationship" | "fields:latitude" | "fields:linkedTo" | "fields:linkType" | "fields:longitude" | "fields:openInNewTab" | "fields:passwordsDoNotMatch" | "fields:removeRelationship" | "fields:removeUpload" | "fields:saveChanges" | "fields:searchForBlock" | "fields:searchForLanguage" | "fields:selectFieldsToEdit" | "fields:showAll" | "fields:swapRelationship" | "fields:swapUpload" | "fields:textToDisplay" | "fields:toggleBlock" | "fields:uploadNewLabel" | "folder:browseByFolder" | "folder:byFolder" | "folder:deleteFolder" | "folder:folderName" | "folder:folders" | "folder:folderTypeDescription" | "folder:itemHasBeenMoved" | "folder:itemHasBeenMovedToRoot" | "folder:itemsMovedToFolder" | "folder:itemsMovedToRoot" | "folder:moveFolder" | "folder:moveItemsToFolderConfirmation" | "folder:moveItemsToRootConfirmation" | "folder:moveItemToFolderConfirmation" | "folder:moveItemToRootConfirmation" | "folder:movingFromFolder" | "folder:newFolder" | "folder:noFolder" | "folder:renameFolder" | "folder:searchByNameInFolder" | "folder:selectFolderForItem" | "general:items" | "general:of" | "general:language" | "general:dashboard" | "general:error" | "general:username" | "general:notFound" | "general:unauthorized" | "general:newLabel" | "general:saveChanges" | "general:name" | "general:aboutToDelete" | "general:aboutToPermanentlyDelete" | "general:aboutToPermanentlyDeleteTrash" | "general:aboutToRestore" | "general:aboutToRestoreAsDraft" | "general:aboutToRestoreAsDraftCount" | "general:aboutToRestoreCount" | "general:aboutToTrash" | "general:aboutToTrashCount" | "general:addBelow" | "general:addFilter" | "general:adminTheme" | "general:all" | "general:allCollections" | "general:allLocales" | "general:and" | "general:anotherUser" | "general:anotherUserTakenOver" | "general:applyChanges" | "general:ascending" | "general:automatic" | "general:backToDashboard" | "general:cancel" | "general:changesNotSaved" | "general:clear" | "general:clearAll" | "general:close" | "general:collapse" | "general:collections" | "general:columns" | "general:columnToSort" | "general:confirm" | "general:confirmCopy" | "general:confirmDeletion" | "general:confirmDuplication" | "general:confirmMove" | "general:confirmReindex" | "general:confirmReindexAll" | "general:confirmReindexDescription" | "general:confirmReindexDescriptionAll" | "general:confirmRestoration" | "general:copied" | "general:copy" | "general:copyField" | "general:copying" | "general:copyRow" | "general:copyWarning" | "general:create" | "general:created" | "general:createdAt" | "general:createNew" | "general:createNewLabel" | "general:creating" | "general:creatingNewLabel" | "general:currentlyEditing" | "general:custom" | "general:dark" | "general:delete" | "general:deleted" | "general:deletedAt" | "general:deletedCountSuccessfully" | "general:deletedSuccessfully" | "general:deleteLabel" | "general:deletePermanently" | "general:deleting" | "general:depth" | "general:descending" | "general:deselectAllRows" | "general:document" | "general:documentIsTrashed" | "general:documentLocked" | "general:documents" | "general:duplicate" | "general:duplicateWithoutSaving" | "general:edit" | "general:editAll" | "general:editedSince" | "general:editing" | "general:editingTakenOver" | "general:editLabel" | "general:email" | "general:emailAddress" | "general:emptyTrash" | "general:emptyTrashLabel" | "general:enterAValue" | "general:errors" | "general:exitLivePreview" | "general:export" | "general:fallbackToDefaultLocale" | "general:false" | "general:filters" | "general:filterWhere" | "general:globals" | "general:goBack" | "general:groupByLabel" | "general:import" | "general:isEditing" | "general:item" | "general:lastModified" | "general:layout" | "general:leaveAnyway" | "general:leaveWithoutSaving" | "general:light" | "general:livePreview" | "general:loading" | "general:locale" | "general:locales" | "general:lock" | "general:menu" | "general:moreOptions" | "general:move" | "general:moveConfirm" | "general:moveCount" | "general:moveDown" | "general:moveUp" | "general:moving" | "general:movingCount" | "general:next" | "general:no" | "general:noDateSelected" | "general:noFiltersSet" | "general:noLabel" | "general:none" | "general:noOptions" | "general:noResults" | "general:noResultsDescription" | "general:noResultsFound" | "general:nothingFound" | "general:noTrashResults" | "general:noUpcomingEventsScheduled" | "general:noValue" | "general:only" | "general:open" | "general:or" | "general:order" | "general:overwriteExistingData" | "general:pageNotFound" | "general:password" | "general:pasteField" | "general:pasteRow" | "general:payloadSettings" | "general:permanentlyDelete" | "general:permanentlyDeletedCountSuccessfully" | "general:perPage" | "general:previous" | "general:reindex" | "general:reindexingAll" | "general:remove" | "general:rename" | "general:reset" | "general:resetPreferences" | "general:resetPreferencesDescription" | "general:resettingPreferences" | "general:restore" | "general:restoreAsPublished" | "general:restoredCountSuccessfully" | "general:restoring" | "general:row" | "general:rows" | "general:save" | "general:saving" | "general:schedulePublishFor" | "general:searchBy" | "general:select" | "general:selectAll" | "general:selectAllRows" | "general:selectedCount" | "general:selectLabel" | "general:selectValue" | "general:showAllLabel" | "general:sorryNotFound" | "general:sort" | "general:sortByLabelDirection" | "general:stayOnThisPage" | "general:submissionSuccessful" | "general:submit" | "general:submitting" | "general:success" | "general:successfullyCreated" | "general:successfullyDuplicated" | "general:successfullyReindexed" | "general:takeOver" | "general:thisLanguage" | "general:time" | "general:timezone" | "general:titleDeleted" | "general:titleRestored" | "general:titleTrashed" | "general:trash" | "general:trashedCountSuccessfully" | "general:true" | "general:unlock" | "general:unsavedChanges" | "general:unsavedChangesDuplicate" | "general:untitled" | "general:upcomingEvents" | "general:updatedAt" | "general:updatedCountSuccessfully" | "general:updatedLabelSuccessfully" | "general:updatedSuccessfully" | "general:updateForEveryone" | "general:updating" | "general:uploading" | "general:uploadingBulk" | "general:user" | "general:users" | "general:value" | "general:viewing" | "general:viewReadOnly" | "general:welcome" | "general:yes" | "localization:cannotCopySameLocale" | "localization:copyFrom" | "localization:copyFromTo" | "localization:copyTo" | "localization:copyToLocale" | "localization:localeToPublish" | "localization:selectedLocales" | "localization:selectLocaleToCopy" | "localization:selectLocaleToDuplicate" | "operators:contains" | "operators:equals" | "operators:exists" | "operators:intersects" | "operators:near" | "operators:within" | "operators:isGreaterThan" | "operators:isGreaterThanOrEqualTo" | "operators:isIn" | "operators:isLessThan" | "operators:isLessThanOrEqualTo" | "operators:isLike" | "operators:isNotEqualTo" | "operators:isNotIn" | "operators:isNotLike" | "upload:addFile" | "upload:addFiles" | "upload:bulkUpload" | "upload:crop" | "upload:cropToolDescription" | "upload:download" | "upload:dragAndDrop" | "upload:editImage" | "upload:fileName" | "upload:fileSize" | "upload:filesToUpload" | "upload:fileToUpload" | "upload:focalPoint" | "upload:focalPointDescription" | "upload:height" | "upload:noFile" | "upload:pasteURL" | "upload:previewSizes" | "upload:selectCollectionToBrowse" | "upload:selectFile" | "upload:setCropArea" | "upload:setFocalPoint" | "upload:sizes" | "upload:sizesFor" | "upload:width" | "validation:username" | "validation:emailAddress" | "validation:enterNumber" | "validation:fieldHasNo" | "validation:greaterThanMax" | "validation:invalidBlock" | "validation:invalidBlocks" | "validation:invalidInput" | "validation:invalidSelection" | "validation:invalidSelections" | "validation:latitudeOutOfBounds" | "validation:lessThanMin" | "validation:limitReached" | "validation:longerThanMin" | "validation:longitudeOutOfBounds" | "validation:notValidDate" | "validation:required" | "validation:requiresAtLeast" | "validation:requiresNoMoreThan" | "validation:requiresTwoNumbers" | "validation:shorterThanMax" | "validation:timezoneRequired" | "validation:trueOrFalse" | "validation:validUploadID" | "version:version" | "version:aboutToRestore" | "version:restoring" | "version:type" | "version:aboutToPublishSelection" | "version:aboutToRestoreGlobal" | "version:aboutToRevertToPublished" | "version:aboutToUnpublish" | "version:aboutToUnpublishIn" | "version:aboutToUnpublishSelection" | "version:autosave" | "version:autosavedSuccessfully" | "version:autosavedVersion" | "version:changed" | "version:compareVersions" | "version:comparingAgainst" | "version:confirmPublish" | "version:confirmRevertToSaved" | "version:confirmUnpublish" | "version:confirmVersionRestoration" | "version:currentDraft" | "version:currentlyPublished" | "version:currentlyViewing" | "version:currentPublishedVersion" | "version:draft" | "version:draftHasPublishedVersion" | "version:draftSavedSuccessfully" | "version:lastSavedAgo" | "version:modifiedOnly" | "version:moreVersions" | "version:noFurtherVersionsFound" | "version:noLabelGroup" | "version:noRowsFound" | "version:noRowsSelected" | "version:preview" | "version:previouslyDraft" | "version:previouslyPublished" | "version:previousVersion" | "version:problemRestoringVersion" | "version:publish" | "version:publishAllLocales" | "version:publishChanges" | "version:published" | "version:publishIn" | "version:publishing" | "version:restoreAsDraft" | "version:restoredSuccessfully" | "version:restoreThisVersion" | "version:reverting" | "version:revertToPublished" | "version:revertUnsuccessful" | "version:saveDraft" | "version:scheduledSuccessfully" | "version:schedulePublish" | "version:selectLocales" | "version:selectVersionToCompare" | "version:showLocales" | "version:specificVersion" | "version:status" | "version:unpublish" | "version:unpublished" | "version:unpublishedSuccessfully" | "version:unpublishIn" | "version:unpublishing" | "version:versionAgo" | "version:versionID" | "version:versions" | "version:viewingVersion" | "version:viewingVersionGlobal" | "version:viewingVersions" | "version:viewingVersionsGlobal" | "general:aboutToDeleteCount" | "general:editingLabel" | "version:changedFieldsCount">;
+};
+
+/**
+ * Check if a label is a multi-language record.
+ */
+declare function isMultiLang(label: string | Record<string, string>): label is Record<string, string>;
+/**
+ * Resolve a potentially multi-language label to a string.
+ * Falls back to: lang → fallback → first available value → empty string.
+ */
+declare function resolveLabel(label: string | Record<string, string>, lang: string, fallback?: string): string;
+
+export { AdminNav, GroupEditor, IconPicker, NavCustomizer, NavItemEditor, type PluginAdminNavTranslationKeys, SortableGroup, SortableItem, isMultiLang, resolveLabel, useNavPreferences, usePluginTranslation };