Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/articles/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ const TextPage = lazy(() => import('./pages/Text'));

// Create the renderer and load fonts
const { render } = createRenderer();
loadFonts(fonts);
await loadFonts(fonts);

// Render the app using the HashRouter from SolidRouter
render(() => (
Expand Down
2 changes: 1 addition & 1 deletion docs/articles/migration-2x-to-3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Shaders are imported when needed by application. The following example shows how

```typescript
const { renderer, render } = createRenderer();
loadFonts(fonts);
await loadFonts(fonts);
// Prepare for RC3 of Renderer
import {
Rounded,
Expand Down
8 changes: 8 additions & 0 deletions docs/essentials/render.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,34 +54,42 @@ For the latest renderer options read the official [renderer documentation](https
### Config.rendererOptions

- **appWidth**: Authored logical pixel width of the application.

- _Default_: `1920`

- **appHeight**: Authored logical pixel height of the application.

- _Default_: `1080`

- **txMemByteThreshold**: Texture Memory Byte Threshold. When the GPU VRAM used by textures exceeds this threshold, non-visible textures are freed. Set to `0` to disable.

- **boundsMargin**: Bounds margin to extend the boundary for adding a CoreNode as Quad. Can be a single number or an array of four numbers.

- **deviceLogicalPixelRatio**: Factor to convert app-authored logical coordinates to device logical coordinates. Supports auto-scaling for different resolutions.

- _Default_: `1`

- **devicePhysicalPixelRatio**: Factor to convert device logical coordinates to device physical coordinates. Controls the number of physical pixels used per logical pixel.

- _Default_: `window.devicePixelRatio`

- **clearColor**: RGBA encoded number for the background color.

- _Default_: `0x00000000`

- **Texture Memory Manager Settings**:
textureMemory?: Partial<TextureMemoryManagerSettings>;

- **fpsUpdateInterval**: Interval in milliseconds for receiving FPS updates. Set to `0` to disable.

- _Default_: `0`

- **enableContextSpy**: Includes WebGL context call information in FPS updates. Significantly impacts performance.

- _Default_: `false`

- **numImageWorkers**: Number of image workers to use. Improves image loading on multi-core devices. Set to `0` to disable.

- _Default_: `2`

- **inspector**
Expand Down
2 changes: 1 addition & 1 deletion docs/essentials/text.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Then you'll need to register the custom font in the AppCoreExtensions file:
} as const];

// must be called after createRenderer but before render
loadFonts(fonts);
await loadFonts(fonts);
```

From this moment on you'll be able to use the font `ComicSans` anywhere in your App:
Expand Down
1 change: 1 addition & 0 deletions docs/primitives/createTag.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ const App = () => {
Creates a tag component from the provided children.

- **Parameters**:

- `children`: The SolidTV/SolidTV elements to render into the texture.

- **Returns**:
Expand Down
3 changes: 3 additions & 0 deletions docs/primitives/grid.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,18 @@ The `Grid` component is simplified version of combining Column & Row and doesn't
### Behavior

1. **Grid Navigation**:

- The `Grid` supports navigation via `onUp`, `onDown`, `onLeft`, and `onRight` events.
- Navigation is column-aware, ensuring horizontal navigation stays within the same row unless looping is enabled.

2. **Looping**:

- When `looping` is enabled, navigation wraps around when reaching the grid boundaries.
- For vertical navigation, reaching the last row loops to the first row and vice versa.
- For horizontal navigation, reaching the end of a row wraps to the start of the same row.

3. **Focus Handling**:

- The `Grid` manages focus internally using a `focusedIndex` signal.
- The `onSelectedChanged` callback is invoked when the focused index changes.

Expand Down
3 changes: 3 additions & 0 deletions docs/primitives/row_column.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,18 @@ The components accept the following props:
#### Behavior

1. **Navigation**:

- The `Row` listens for left and right navigation events.
- The `Column` listens for up and down navigation events.
- The `onLeft` and `onRight` handlers can be customized, and default navigation logic is provided via `handleNavigation`.

2. **Focus Management**:

- Focus events are handled via the `onFocus` prop.
- When focus changes, the row ensures that the currently selected child is highlighted and optionally scrolls into view.

3. **Scrolling**:

- The `withScrolling` utility is used to handle scrolling behavior when the `scroll` prop is set to `'auto'` or `'always'`.

4. **Styling**:
Expand Down
1 change: 1 addition & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ export default tseslint.config(
parserOptions: {
project: true,
tsconfigRootDir: import.meta.dirname,
warnOnUnsupportedTypeScriptVersion: false,
},
globals: {
...globals.browser,
Expand Down
Loading
Loading