Skip to content

Commit a67a71d

Browse files
committed
docs: update website for v2 packages
1 parent 76f86c5 commit a67a71d

27 files changed

Lines changed: 332 additions & 60 deletions

website/docs/android/development/custom-fonts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The plugin copies each font file to `android/app/src/main/assets/fonts/` automat
3838
### 3. Use `renderAsBitmap` on Text
3939

4040
```tsx
41-
import { VoltraAndroid } from '@use-voltra/android-client'
41+
import { VoltraAndroid } from '@use-voltra/android'
4242

4343
<VoltraAndroid.Text
4444
renderAsBitmap

website/docs/android/development/developing-widgets.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ On Android, you use `VoltraAndroid` components which map to Glance primitives:
1717
### Example Widget
1818

1919
```tsx
20-
import { VoltraAndroid } from '@use-voltra/android-client'
20+
import { VoltraAndroid } from '@use-voltra/android'
2121

2222
const WeatherWidget = ({ temperature, condition }) => (
2323
<VoltraAndroid.Box
@@ -43,12 +43,12 @@ const WeatherWidget = ({ temperature, condition }) => (
4343

4444
## Update API
4545

46-
To update a widget's content, use the `updateWidget` function from `@use-voltra/android-client`:
46+
To update a widget's content, use the `updateAndroidWidget` function from `@use-voltra/android-client`:
4747

4848
```typescript
49-
import { updateWidget } from '@use-voltra/android-client'
49+
import { updateAndroidWidget } from '@use-voltra/android-client'
5050

51-
await updateWidget('weather_widget', <WeatherWidget temperature={22} condition="Sunny" />)
51+
await updateAndroidWidget('weather_widget', <WeatherWidget temperature={22} condition="Sunny" />)
5252
```
5353

5454
## Layout Constraints

website/docs/android/development/dynamic-colors.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ These colors follow the current Android Material palette, so widgets can pick up
77
## Importing dynamic colors
88

99
```tsx
10-
import { AndroidDynamicColors, VoltraAndroid } from '@use-voltra/android-client'
10+
import { AndroidDynamicColors, VoltraAndroid } from '@use-voltra/android'
1111
```
1212

1313
`AndroidDynamicColors` includes these roles:
@@ -43,7 +43,7 @@ import { AndroidDynamicColors, VoltraAndroid } from '@use-voltra/android-client'
4343
## Example
4444

4545
```tsx
46-
import { AndroidDynamicColors, VoltraAndroid } from '@use-voltra/android-client'
46+
import { AndroidDynamicColors, VoltraAndroid } from '@use-voltra/android'
4747

4848
export function WeatherWidget() {
4949
return (
@@ -95,7 +95,7 @@ You can use `AndroidDynamicColors.*` anywhere Android accepts a color value, inc
9595
Dynamic color tokens work in server-rendered Android widgets too.
9696

9797
```tsx
98-
import { AndroidDynamicColors, VoltraAndroid } from '@use-voltra/android-client'
98+
import { AndroidDynamicColors, VoltraAndroid } from '@use-voltra/android'
9999

100100
const content = (
101101
<VoltraAndroid.Box

website/docs/android/development/image-preloading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ await clearPreloadedImages()
8181
Once images are preloaded, reference them using the `assetName` property in the `VoltraAndroid.Image` component:
8282

8383
```tsx
84-
import { VoltraAndroid } from '@use-voltra/android-client'
84+
import { VoltraAndroid } from '@use-voltra/android'
8585

8686
function MusicWidget({ albumKey }) {
8787
return (

website/docs/android/development/images.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Android drawable resources have strict naming conventions. Voltra automatically
5353
Reference these images using their sanitized name in the `assetName` property. You do not need to include the file extension.
5454

5555
```tsx
56-
import { VoltraAndroid } from '@use-voltra/android-client'
56+
import { VoltraAndroid } from '@use-voltra/android'
5757

5858
// assets/voltra-android/logo.png -> "logo"
5959
<VoltraAndroid.Image
@@ -81,7 +81,7 @@ The image preloading system works by:
8181
Once images are preloaded, reference them using the key you provided:
8282

8383
```tsx
84-
import { VoltraAndroid } from '@use-voltra/android-client'
84+
import { VoltraAndroid } from '@use-voltra/android'
8585

8686
function ProfileWidget({ user }) {
8787
return (

website/docs/android/development/managing-ongoing-notifications.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,8 @@ Voltra provides two built-in layouts:
123123
### Progress notification
124124

125125
```tsx
126+
import { AndroidOngoingNotification } from '@use-voltra/android'
126127
import {
127-
AndroidOngoingNotification,
128128
startAndroidOngoingNotification,
129129
} from '@use-voltra/android-client'
130130

@@ -150,8 +150,8 @@ if (result.ok) {
150150
### Big text notification
151151

152152
```tsx
153+
import { AndroidOngoingNotification } from '@use-voltra/android'
153154
import {
154-
AndroidOngoingNotification,
155155
startAndroidOngoingNotification,
156156
} from '@use-voltra/android-client'
157157

@@ -173,8 +173,8 @@ await startAndroidOngoingNotification(
173173
Use the same `notificationId` to update an existing notification.
174174

175175
```tsx
176+
import { AndroidOngoingNotification } from '@use-voltra/android'
176177
import {
177-
AndroidOngoingNotification,
178178
updateAndroidOngoingNotification,
179179
} from '@use-voltra/android-client'
180180

@@ -196,8 +196,8 @@ await updateAndroidOngoingNotification(
196196
If your app may re-enter the same flow multiple times, `upsertAndroidOngoingNotification()` can be easier than separate start/update logic.
197197

198198
```tsx
199+
import { AndroidOngoingNotification } from '@use-voltra/android'
199200
import {
200-
AndroidOngoingNotification,
201201
upsertAndroidOngoingNotification,
202202
} from '@use-voltra/android-client'
203203

@@ -242,7 +242,7 @@ await endAllAndroidOngoingNotifications()
242242
For React screens and flows, use `useAndroidOngoingNotification()`.
243243

244244
```tsx
245-
import { AndroidOngoingNotification } from '@use-voltra/android-client'
245+
import { AndroidOngoingNotification } from '@use-voltra/android'
246246
import { useAndroidOngoingNotification } from '@use-voltra/android-client'
247247

248248
function DeliveryNotification({ orderId, etaMinutes }) {
@@ -280,7 +280,7 @@ Use `autoStart` to create the notification when the component mounts, and `autoU
280280
You can add action buttons as children of `Progress` or `BigText`.
281281

282282
```tsx
283-
import { AndroidOngoingNotification } from '@use-voltra/android-client'
283+
import { AndroidOngoingNotification } from '@use-voltra/android'
284284

285285
<AndroidOngoingNotification.Progress title="Driver is approaching" value={32} max={100}>
286286
<AndroidOngoingNotification.Action

website/docs/android/development/server-driven-widgets.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,13 @@ On the Android emulator, use `10.0.2.2` instead of `localhost` to reach the host
6060

6161
## Building the server
6262

63-
Voltra provides widget server handlers for the common runtime styles. Use `createWidgetUpdateHandler()` for Fetch-compatible runtimes, `createWidgetUpdateNodeHandler()` for `node:http`, and `createWidgetUpdateExpressHandler()` for Express-style handlers. All three share the same request parsing, platform validation, token validation, and response serialization.
63+
Voltra provides widget server handlers for the common runtime styles. Use `createAndroidWidgetUpdateHandler()` for Fetch-compatible runtimes, `createAndroidWidgetUpdateNodeHandler()` for `node:http`, and `createAndroidWidgetUpdateExpressHandler()` for Express-style handlers. All three share the same request parsing, platform validation, token validation, and response serialization.
6464

6565
```tsx
6666
import { createServer } from 'node:http'
6767
import React from 'react'
6868
import { createAndroidWidgetUpdateNodeHandler } from '@use-voltra/android-server'
69-
import { AndroidDynamicColors, VoltraAndroid } from '@use-voltra/android-client'
69+
import { AndroidDynamicColors, VoltraAndroid } from '@use-voltra/android'
7070

7171
const handler = createAndroidWidgetUpdateNodeHandler({
7272
render: async (req) => {
@@ -186,13 +186,13 @@ Your server should return all size variants in every response. When the user res
186186
You can force-refresh server-driven widgets outside of the regular interval:
187187

188188
```typescript
189-
import { reloadWidgets } from '@use-voltra/android-client'
189+
import { reloadAndroidWidgets } from '@use-voltra/android-client'
190190

191191
// Reload specific widgets (triggers an immediate WorkManager fetch)
192-
await reloadWidgets(['dynamic_weather'])
192+
await reloadAndroidWidgets(['dynamic_weather'])
193193

194194
// Reload all widgets
195-
await reloadWidgets()
195+
await reloadAndroidWidgets()
196196
```
197197

198198
For server-driven widgets, this enqueues an immediate one-time WorkManager request to fetch fresh content. For local-only widgets, it re-renders from cached data.
@@ -224,9 +224,13 @@ Provide a meaningful initial state (e.g. "Loading..." or placeholder content) ra
224224

225225
## Cross-platform server
226226

227-
A single server can handle both iOS and Android requests using `createWidgetUpdateHandler`:
227+
A single server can handle both iOS and Android requests using `createWidgetUpdateHandler` from `@use-voltra/server`:
228228

229229
```tsx
230+
import { Voltra } from '@use-voltra/ios'
231+
import { AndroidDynamicColors, VoltraAndroid } from '@use-voltra/android'
232+
import { createWidgetUpdateHandler } from '@use-voltra/server'
233+
230234
const handler = createWidgetUpdateHandler({
231235
renderIos: async (req) => {
232236
// Return WidgetVariants (systemSmall, systemMedium, etc.)
@@ -245,7 +249,7 @@ const handler = createWidgetUpdateHandler({
245249

246250
The handler uses the required `platform` query parameter to route requests to the correct render function.
247251

248-
If you're serving the endpoint from Node or Express, use `createWidgetUpdateNodeHandler()` or `createWidgetUpdateExpressHandler()` instead.
252+
If you're serving the cross-platform endpoint from Node or Express, use `createWidgetUpdateNodeHandler()` or `createWidgetUpdateExpressHandler()` from `@use-voltra/server` instead.
249253

250254
## Architecture overview
251255

website/docs/android/development/styling.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ In addition to general styles, `Image` components support:
4949
Android widgets can use semantic Material color roles that resolve through native `GlanceTheme.colors.*` values during rendering.
5050

5151
```tsx
52-
import { AndroidDynamicColors, VoltraAndroid } from '@use-voltra/android-client'
52+
import { AndroidDynamicColors, VoltraAndroid } from '@use-voltra/android'
5353

5454
const element = (
5555
<VoltraAndroid.Box
@@ -89,7 +89,7 @@ The following properties are **NOT supported** on Android due to Glance limitati
8989
## Example
9090

9191
```tsx
92-
import { VoltraAndroid } from '@use-voltra/android-client'
92+
import { VoltraAndroid } from '@use-voltra/android'
9393

9494
const element = (
9595
<VoltraAndroid.Column

website/docs/android/development/testing-and-previews.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The `VoltraWidgetPreview` component renders Voltra Android JSX content at the ex
1414
### Usage
1515

1616
```tsx
17-
import { VoltraAndroid } from '@use-voltra/android-client'
17+
import { VoltraAndroid } from '@use-voltra/android'
1818
import { VoltraWidgetPreview } from '@use-voltra/android-client'
1919

2020
export function MyWidgetPreview() {
@@ -54,6 +54,7 @@ Android widgets use responsive sizing. Voltra provides several standard families
5454
If you need more control or want to test custom dimensions, you can use the low-level `VoltraView` component.
5555

5656
```tsx
57+
import { VoltraAndroid } from '@use-voltra/android'
5758
import { VoltraView } from '@use-voltra/android-client'
5859

5960
<VoltraView style={{ width: 200, height: 100 }}>

website/docs/android/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Voltra also supports Android ongoing notifications for app-driven, persistent st
1919
### Simple Android Widget
2020

2121
```tsx
22-
import { VoltraAndroid } from '@use-voltra/android-client'
22+
import { VoltraAndroid } from '@use-voltra/android'
2323

2424
const MyWidget = () => (
2525
<VoltraAndroid.Column

0 commit comments

Comments
 (0)