Skip to content

docs(uikit): add "Why Use the Storage Plugin?" section with real-world examples#8

Merged
pasevin merged 5 commits intocursor/openzeppelin-uikit-documentation-5e15from
cursor/uikit-storage-why-section-6e41
Apr 9, 2026
Merged

docs(uikit): add "Why Use the Storage Plugin?" section with real-world examples#8
pasevin merged 5 commits intocursor/openzeppelin-uikit-documentation-5e15from
cursor/uikit-storage-why-section-6e41

Conversation

@pasevin
Copy link
Copy Markdown
Owner

@pasevin pasevin commented Apr 9, 2026

Documentation Pull Request

Summary

Three documentation improvements across the UIKit Storage and Components pages, based on a full audit of the openzeppelin-ui package source code:

1. Storage page — "Why Use the Storage Plugin?" section (previous commits)

  • Comparison table: localStorage vs @openzeppelin/ui-storage (IndexedDB)
  • Real-world examples from UI Builder and Role Manager
  • Account alias plugin screenshot with side-by-side layout

2. Storage page — React Hook Factories section (new)

  • Documents createRepositoryHook — the main factory that combines live queries, CRUD, and file I/O into a single hook
  • Documents lower-level factories: createLiveQueryHook, createCrudHook, createJsonFileIO
  • Includes complete code examples and a return-value reference table

3. Components page — missing UI primitives and form fields (new)

  • Added 11 missing general components: Calendar/DateRangePicker, DropdownMenu, EmptyState, ExternalLink, Form, Header/Footer, Popover, Sonner
  • Added 3 missing blockchain-specific components: NetworkIcon, NetworkStatusBadge, ViewContractStateButton
  • Added 6 missing form field types: CodeEditorField, DateTimeField, FileUploadField, PasswordField, UrlField, ArrayObjectField

storage_hooks_and_components_tables_walkthrough.mp4

React Hook Factories section on Storage page
Updated General Components table
Updated Form Fields table

Type of Change

  • New documentation
  • Documentation update/revision
  • Fix typos or grammar
  • Restructure/reorganize content
  • Add examples or tutorials
  • Update API documentation
  • Other: ___________

Related Issues

N/A

Checklist

Additional Notes

This PR targets the cursor/openzeppelin-uikit-documentation-5e15 branch 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.

Open in Web Open in Cursor 

cursoragent and others added 5 commits April 9, 2026 16:53
… 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>
@pasevin pasevin marked this pull request as ready for review April 9, 2026 20:01
@pasevin pasevin merged commit d64d55b into cursor/openzeppelin-uikit-documentation-5e15 Apr 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants