docs(uikit): add "Why Use the Storage Plugin?" section with real-world examples#8
Merged
pasevin merged 5 commits intocursor/openzeppelin-uikit-documentation-5e15from Apr 9, 2026
Conversation
… examples Co-authored-by: Aleksandr Pasevin <aleksandr.pasevin@openzeppelin.com>
Co-authored-by: Aleksandr Pasevin <aleksandr.pasevin@openzeppelin.com>
Co-authored-by: Aleksandr Pasevin <aleksandr.pasevin@openzeppelin.com>
…ateCrudHook, createLiveQueryHook, createJsonFileIO) Co-authored-by: Aleksandr Pasevin <aleksandr.pasevin@openzeppelin.com>
…ents page Co-authored-by: Aleksandr Pasevin <aleksandr.pasevin@openzeppelin.com>
9 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Pull Request
Summary
Three documentation improvements across the UIKit Storage and Components pages, based on a full audit of the
openzeppelin-uipackage source code:1. Storage page — "Why Use the Storage Plugin?" section (previous commits)
localStoragevs@openzeppelin/ui-storage(IndexedDB)2. Storage page — React Hook Factories section (new)
createRepositoryHook— the main factory that combines live queries, CRUD, and file I/O into a single hookcreateLiveQueryHook,createCrudHook,createJsonFileIO3. Components page — missing UI primitives and form fields (new)
Calendar/DateRangePicker,DropdownMenu,EmptyState,ExternalLink,Form,Header/Footer,Popover,SonnerNetworkIcon,NetworkStatusBadge,ViewContractStateButtonCodeEditorField,DateTimeField,FileUploadField,PasswordField,UrlField,ArrayObjectFieldstorage_hooks_and_components_tables_walkthrough.mp4
React Hook Factories section on Storage page
Updated General Components table
Updated Form Fields table
Type of Change
Related Issues
N/A
Checklist
pnpm run buildpnpm run checkAdditional Notes
This PR targets the
cursor/openzeppelin-uikit-documentation-5e15branch where the UIKit docs are being developed. All new content was sourced from the actual package exports in openzeppelin-ui and validated against real usage in the UI Builder and Role Manager repos.To show artifacts inline, enable in settings.