mirrors/isoflow
1
0
Fork 0
mirror of https://github.com/markmanx/isoflow.git synced 2025-01-31 23:22:31 +00:00
Code Issues Projects Releases Packages 2 Wiki Activity Actions

fix: updates documentation link prefixes

Browse source
This commit is contained in:
Mark Mankarious 2023-08-25 18:22:45 +01:00
parent a279729dc6
commit 61e03f3367
3 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/pages/docs/api/index.mdx
View file

@ -2,7 +2,7 @@
| Name | Type | Description | Default | | Name | Type | Description | Default |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `initialData` | [`object`](docs/api/initialData) | The initial scene that Isoflow should render. If `undefined`, isoflow loads a blank scene. | `undefined` | | `initialData` | [`object`](/docs/api/initialData) | The initial scene that Isoflow should render. If `undefined`, isoflow loads a blank scene. | `undefined` |
| `width` | `number` \| `string` | Width of the Isoflow renderer as a CSS value. | `100%` | | `width` | `number` \| `string` | Width of the Isoflow renderer as a CSS value. | `100%` |
| `height` | `number` \| `string` | Height of the Isoflow renderer as a CSS value. | `100%` | | `height` | `number` \| `string` | Height of the Isoflow renderer as a CSS value. | `100%` |
| `onSceneUpdate` | `function` | A callback that is triggered whenever an item is added, updated or removed from the scene. The callback is called with the updated scene as the first argument. | `undefined` | | `onSceneUpdate` | `function` | A callback that is triggered whenever an item is added, updated or removed from the scene. The callback is called with the updated scene as the first argument. | `undefined` |

4
docs/pages/docs/api/initialData.mdx
View file

@ -23,7 +23,7 @@ The `initialData` object contains the following properties:
**Notes on icons:** **Notes on icons:**
- `category` is an optional property that can be used to group icons together in the icon picker. All icons with the same `category` will be grouped together. - `category` is an optional property that can be used to group icons together in the icon picker. All icons with the same `category` will be grouped together.
- For a list of standard icon `id`s, see [Isopacks](isopacks#icon-ids). - For a list of standard icon `id`s, see [Isopacks](/docs/isopacks#icon-ids).
## `Node` ## `Node`
@ -92,7 +92,7 @@ If the reference is another `node`, the anchor's position is dynamic and will be
## `initialData` example ## `initialData` example
Open this example in [CodeSandbox](https://codesandbox.io/p/sandbox/github/markmanx/isoflow/tree/main). Open this example in [CodeSandbox](https://codesandbox.io/p/sandbox/github/markmanx/isoflow/tree/main).
**Note:** This example assumes the `networkingIsopack` is imported from `isoflow/dist/isopacks`. See [Loading Isopacks](isopacks). **Note:** This example assumes the `networkingIsopack` is imported from `isoflow/dist/isopacks`. See [Loading Isopacks](/docs/isopacks).
```js ```js
{ {

2
docs/pages/docs/quickstart.mdx
View file

@ -23,7 +23,7 @@ const App = () => {
export default App; export default App;
``` ```
**Note**: this will display a blank Isoflow editor, without icons (which is not very useful!). To initialise the editor with an iconset, see [Loading Isopacks](./isopacks). **Note**: this will display a blank Isoflow editor, without icons (which is not very useful!). To initialise the editor with an iconset, see [Loading Isopacks](/docs/isopacks).
### Dimensions of Isoflow ### Dimensions of Isoflow