Skip to content

Commit

Permalink
Fixes docs
Browse files Browse the repository at this point in the history
  • Loading branch information
codenikel committed Oct 24, 2023
1 parent 11e8e99 commit 10f16bf
Show file tree
Hide file tree
Showing 35 changed files with 298 additions and 104 deletions.
2 changes: 1 addition & 1 deletion sdk/web/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
radiant-sdk / [Exports](modules.md)
radiant-sdk / [Modules](modules.md)

# Radiant Web SDK
155 changes: 155 additions & 0 deletions sdk/web/docs/classes/controller.RadiantController.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
[radiant-sdk](../README.md) / [Modules](../modules.md) / [controller](../modules/controller.md) / RadiantController

# Class: RadiantController

[controller](../modules/controller.md).RadiantController

## Table of contents

### Constructors

- [constructor](controller.RadiantController.md#constructor)

### Properties

- [\_controller](controller.RadiantController.md#_controller)

### Methods

- [activateTool](controller.RadiantController.md#activatetool)
- [setFillColor](controller.RadiantController.md#setfillcolor)
- [setStrokeColor](controller.RadiantController.md#setstrokecolor)
- [setTransform](controller.RadiantController.md#settransform)
- [createController](controller.RadiantController.md#createcontroller)

## Constructors

### constructor

**new RadiantController**(`controller`)

#### Parameters

| Name | Type |
| :------ | :------ |
| `controller` | `RadiantAppController` |

#### Defined in

[controller/index.ts:6](https://github.com/radiant-labs/radiant/blob/11e8e99/sdk/web/src/controller/index.ts#L6)

## Properties

### \_controller

**\_controller**: `RadiantAppController`

#### Defined in

[controller/index.ts:4](https://github.com/radiant-labs/radiant/blob/11e8e99/sdk/web/src/controller/index.ts#L4)

## Methods

### activateTool

**activateTool**(`tool`): `void`

Activates the provided tool.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `tool` | `string` | the tool to activate. |

#### Returns

`void`

#### Defined in

[controller/index.ts:19](https://github.com/radiant-labs/radiant/blob/11e8e99/sdk/web/src/controller/index.ts#L19)

___

### setFillColor

**setFillColor**(`nodeId`, `color`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `nodeId` | `number` |
| `color` | `number`[] |

#### Returns

`void`

#### Defined in

[controller/index.ts:35](https://github.com/radiant-labs/radiant/blob/11e8e99/sdk/web/src/controller/index.ts#L35)

___

### setStrokeColor

**setStrokeColor**(`nodeId`, `color`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `nodeId` | `number` |
| `color` | `number`[] |

#### Returns

`void`

#### Defined in

[controller/index.ts:44](https://github.com/radiant-labs/radiant/blob/11e8e99/sdk/web/src/controller/index.ts#L44)

___

### setTransform

**setTransform**(`nodeId`, `position`, `scale`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `nodeId` | `number` |
| `position` | `number`[] |
| `scale` | `number`[] |

#### Returns

`void`

#### Defined in

[controller/index.ts:25](https://github.com/radiant-labs/radiant/blob/11e8e99/sdk/web/src/controller/index.ts#L25)

___

### createController

`Static` **createController**(`f`): `Promise`<[`RadiantController`](controller.RadiantController.md)\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `f` | `Function` |

#### Returns

`Promise`<[`RadiantController`](controller.RadiantController.md)\>

#### Defined in

[controller/index.ts:10](https://github.com/radiant-labs/radiant/blob/11e8e99/sdk/web/src/controller/index.ts#L10)
32 changes: 32 additions & 0 deletions sdk/web/docs/interfaces/context.RadiantState.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
[radiant-sdk](../README.md) / [Modules](../modules.md) / [context](../modules/context.md) / RadiantState

# Interface: RadiantState

[context](../modules/context.md).RadiantState

## Table of contents

### Properties

- [controller](context.RadiantState.md#controller)
- [response](context.RadiantState.md#response)

## Properties

### controller

**controller**: ``null`` \| [`RadiantController`](../classes/controller.RadiantController.md)

#### Defined in

[context/index.tsx:6](https://github.com/radiant-labs/radiant/blob/11e8e99/sdk/web/src/context/index.tsx#L6)

___

### response

**response**: `any`

#### Defined in

[context/index.tsx:7](https://github.com/radiant-labs/radiant/blob/11e8e99/sdk/web/src/context/index.tsx#L7)
65 changes: 4 additions & 61 deletions sdk/web/docs/modules.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,10 @@
[radiant-sdk](README.md) / Exports
[radiant-sdk](README.md) / Modules

# radiant-sdk

## Table of contents

### Functions
### Modules

- [RadiantCanvas](modules.md#radiantcanvas)
- [RadiantProvider](modules.md#radiantprovider)
- [useCurrentController](modules.md#usecurrentcontroller)

## Functions

### RadiantCanvas

**RadiantCanvas**(`props`): ``null`` \| `ReactElement`<`any`, `string` \| `JSXElementConstructor`<`any`\>\>

**NOTE**: Exotic components are not callable.

#### Parameters

| Name | Type |
| :------ | :------ |
| `props` | `RefAttributes`<`unknown`\> |

#### Returns

``null`` \| `ReactElement`<`any`, `string` \| `JSXElementConstructor`<`any`\>\>

#### Defined in

node_modules/@types/react/ts5.0/index.d.ts:396

___

### RadiantProvider

**RadiantProvider**(`«destructured»`): `Element`

#### Parameters

| Name | Type |
| :------ | :------ |
| `«destructured»` | `any` |

#### Returns

`Element`

#### Defined in

[sdk/web/src/context/index.tsx:15](https://github.com/radiant-labs/radiant/blob/e0d39ae/sdk/web/src/context/index.tsx#L15)

___

### useCurrentController

**useCurrentController**(): `RadiantState`

#### Returns

`RadiantState`

#### Defined in

[sdk/web/src/context/index.tsx:55](https://github.com/radiant-labs/radiant/blob/e0d39ae/sdk/web/src/context/index.tsx#L55)
- [context](modules/context.md)
- [controller](modules/controller.md)
48 changes: 48 additions & 0 deletions sdk/web/docs/modules/context.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
[radiant-sdk](../README.md) / [Modules](../modules.md) / context

# Module: context

## Table of contents

### Interfaces

- [RadiantState](../interfaces/context.RadiantState.md)

### Functions

- [RadiantProvider](context.md#radiantprovider)
- [useCurrentController](context.md#usecurrentcontroller)

## Functions

### RadiantProvider

**RadiantProvider**(`«destructured»`): `Element`

#### Parameters

| Name | Type |
| :------ | :------ |
| `«destructured»` | `any` |

#### Returns

`Element`

#### Defined in

[context/index.tsx:15](https://github.com/radiant-labs/radiant/blob/11e8e99/sdk/web/src/context/index.tsx#L15)

___

### useCurrentController

**useCurrentController**(): [`RadiantState`](../interfaces/context.RadiantState.md)

#### Returns

[`RadiantState`](../interfaces/context.RadiantState.md)

#### Defined in

[context/index.tsx:55](https://github.com/radiant-labs/radiant/blob/11e8e99/sdk/web/src/context/index.tsx#L55)
9 changes: 9 additions & 0 deletions sdk/web/docs/modules/controller.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[radiant-sdk](../README.md) / [Modules](../modules.md) / controller

# Module: controller

## Table of contents

### Classes

- [RadiantController](../classes/controller.RadiantController.md)
4 changes: 2 additions & 2 deletions sdk/web/lib/cjs/components/RadiantCanvas/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion sdk/web/lib/cjs/components/RadiantCanvas/index.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions sdk/web/lib/cjs/context/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion sdk/web/lib/cjs/context/index.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 7 additions & 1 deletion sdk/web/lib/cjs/controller/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 10f16bf

Please sign in to comment.