Skip to content

Commit 7bd1f0d

Browse files
committed
docs(uikit): point adapter links to ecosystem docs, tidy AddressBook section
- Link to /ecosystem-adapters/building-an-adapter; keep single Next Steps callouts per page. - AddressBookWidget: lead with intro, full-width image below; drop cramped side layout.
1 parent 40d0469 commit 7bd1f0d

5 files changed

Lines changed: 9 additions & 15 deletions

File tree

content/tools/uikit/architecture.mdx

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,6 @@ flowchart TD
8686
| `Relayer` | 3 | Gas-sponsored transaction execution via relayers |
8787
| `AccessControl` | 3 | Role-based access control queries and snapshots |
8888

89-
For more background on the adapter pattern and how chain-specific integrations are structured, see [Building New Adapters](/ui-builder/building-adapters).
90-
9189
### Capability Bundles
9290

9391
Higher-level components request specific **bundles** of capabilities rather than the full set. For example, `TransactionForm` expects a `TransactionFormCapabilities` type: an intersection of the capabilities needed for form rendering, execution, and status tracking.
@@ -134,8 +132,6 @@ Adapters support five standard profiles that define which capabilities are inclu
134132

135133
Choose the lightest profile that fits your use case. A dashboard that only displays contract state can use `viewer`; a full transaction builder should use `composer` or `operator`.
136134

137-
For more background on the adapter architecture, see [Building New Adapters](/ui-builder/building-adapters).
138-
139135
### Runtime Lifecycle
140136

141137
```mermaid
@@ -217,4 +213,4 @@ flowchart TD
217213

218214
- [Components](/tools/uikit/components): Explore all available UI primitives and form fields
219215
- [React Integration](/tools/uikit/react-integration): Deep dive into providers, hooks, and wallet state
220-
- [Building New Adapters](/ui-builder/building-adapters): Background on the adapter pattern and ecosystem integrations
216+
- [Building an adapter](/ecosystem-adapters/building-an-adapter): Background on the adapter pattern and ecosystem integrations

content/tools/uikit/components.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -227,12 +227,12 @@ import { ContractStateWidget } from '@openzeppelin/ui-renderer';
227227
</div>
228228
</div>
229229

230-
![AddressBookWidget](/uikit/address-book-widget.png)
231-
232230
### AddressBookWidget
233231

234232
A full-featured address book UI for managing saved addresses and their human-readable aliases. Supports CRUD operations, search, and import/export.
235233

234+
![AddressBookWidget](/uikit/address-book-widget.png)
235+
236236
`AddressBookWidget` works with the [`@openzeppelin/ui-storage`](/tools/uikit/storage) package, specifically the **account alias plugin** which persists address-to-name mappings in IndexedDB via Dexie.js. When mounted alongside `AddressLabelProvider` and `AddressSuggestionProvider`, saved aliases automatically appear in all `AddressDisplay` and `AddressField` components throughout the app.
237237

238238
```tsx

content/tools/uikit/getting-started.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ pnpm add -D @openzeppelin/ui-dev-cli
4848

4949
### Ecosystem Adapters
5050

51-
You also need at least one ecosystem adapter package for the blockchain(s) your app supports. For background on how adapters are structured, see [Building New Adapters](/ui-builder/building-adapters):
51+
You also need at least one ecosystem adapter package for the blockchain(s) your app supports:
5252

5353
```bash
5454
# EVM (Ethereum, Polygon, Arbitrum, etc.)
@@ -219,4 +219,4 @@ For the full React integration guide, see [React Integration](/tools/uikit/react
219219
- [Components](/tools/uikit/components): Explore UI primitives and blockchain-aware form fields
220220
- [React Integration](/tools/uikit/react-integration): Deep dive into providers, hooks, and wallet state
221221
- [Theming & Styling](/tools/uikit/theming): Customize tokens, colors, and dark mode
222-
- [Building New Adapters](/ui-builder/building-adapters): Background on adapter packages and ecosystem integrations
222+
- [Building an adapter](/ecosystem-adapters/building-an-adapter): Background on adapter packages and ecosystem integrations

content/tools/uikit/index.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ flowchart TD
7575

7676
## Key Design Principles
7777

78-
**Chain-agnostic core.** UIKit packages never import chain-specific logic. Blockchain details are handled entirely by ecosystem adapter packages. For background on the adapter pattern, see [Building New Adapters](/ui-builder/building-adapters).
78+
**Chain-agnostic core.** UIKit packages never import chain-specific logic. Blockchain details are handled entirely by ecosystem adapter packages.
7979

8080
**Capability-driven, not monolithic.** Instead of one large adapter interface, the system defines small, focused [capabilities](/tools/uikit/architecture#capabilities) (addressing, query, execution, wallet, etc.) organized into tiers. Components request only the capabilities they need.
8181

@@ -85,7 +85,7 @@ flowchart TD
8585

8686
## Ecosystem Adapter Integration
8787

88-
UIKit connects to blockchains through ecosystem adapter packages, standalone packages that translate chain-specific operations into the shared capability model. For more background, see [Building New Adapters](/ui-builder/building-adapters).
88+
UIKit connects to blockchains through ecosystem adapter packages, standalone packages that translate chain-specific operations into the shared capability model.
8989

9090
```mermaid
9191
sequenceDiagram
@@ -107,8 +107,6 @@ sequenceDiagram
107107
React-->>App: UI reflects tx status
108108
```
109109

110-
For more background on how adapters work and how new ecosystem integrations are structured, see [Building New Adapters](/ui-builder/building-adapters).
111-
112110
## Requirements
113111

114112
- **Node.js** >= 20.19.0
@@ -119,4 +117,4 @@ For more background on how adapters work and how new ecosystem integrations are
119117

120118
- [Getting Started](/tools/uikit/getting-started): Install, configure, and render your first form
121119
- [Architecture](/tools/uikit/architecture): Deep dive into the capability model and runtime lifecycle
122-
- [Building New Adapters](/ui-builder/building-adapters): How chain-specific logic is decoupled from the UI
120+
- [Building an adapter](/ecosystem-adapters/building-an-adapter): How chain-specific logic is decoupled from the UI

content/tools/uikit/react-integration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,4 +269,4 @@ sequenceDiagram
269269

270270
- [Components](/tools/uikit/components): Browse all available components and form fields
271271
- [Theming & Styling](/tools/uikit/theming): Customize the visual design
272-
- [Building New Adapters](/ui-builder/building-adapters): Background on adapter packages and ecosystem integrations
272+
- [Building an adapter](/ecosystem-adapters/building-an-adapter): Background on adapter packages and ecosystem integrations

0 commit comments

Comments
 (0)