44 lines
1.6 KiB
Markdown
44 lines
1.6 KiB
Markdown
# Function: createPlayground()
|
|
|
|
## createPlayground(container, options)
|
|
|
|
> **createPlayground**(`container`, `options`?): `Promise`\<[`Playground`](../interfaces/Playground.md)\>
|
|
|
|
Creates a LiveCodes playground.
|
|
|
|
### Parameters
|
|
|
|
• **container**: `string` \| `HTMLElement`
|
|
|
|
`HTMLElement` or a string representing a CSS selector. This is the container where the playground is rendered.
|
|
If not found, an error is thrown (except in [headless mode](https://livecodes.io/docs/sdk/headless), in which this parameter is optional and can be omitted).
|
|
|
|
• **options?**: [`EmbedOptions`](../interfaces/EmbedOptions.md)
|
|
|
|
The [embed options](https://livecodes.io/docs/sdk/js-ts#embed-options) for the playground (optional).
|
|
|
|
### Returns
|
|
|
|
`Promise`\<[`Playground`](../interfaces/Playground.md)\>
|
|
|
|
- A promise that resolves to a [`Playground`](https://livecodes.io/docs/api/interfaces/Playground/) object which exposes many [SDK methods](https://livecodes.io/docs/sdk/js-ts/#sdk-methods) that can be used to interact with the playground.
|
|
|
|
### Defined in
|
|
|
|
[index.ts:26](https://github.com/live-codes/livecodes/blob/7617d5c8be5a2a8be8133f973d9e69eb9f86434d/src/sdk/index.ts#L26)
|
|
|
|
## createPlayground(options)
|
|
|
|
> **createPlayground**(`options`): `Promise`\<[`Playground`](../interfaces/Playground.md)\>
|
|
|
|
### Parameters
|
|
|
|
• **options**: [`EmbedOptions`](../interfaces/EmbedOptions.md) & `object`
|
|
|
|
### Returns
|
|
|
|
`Promise`\<[`Playground`](../interfaces/Playground.md)\>
|
|
|
|
### Defined in
|
|
|
|
[index.ts:30](https://github.com/live-codes/livecodes/blob/7617d5c8be5a2a8be8133f973d9e69eb9f86434d/src/sdk/index.ts#L30) |