# @dschz/solid-create-script
[](LICENSE)
[](https://www.npmjs.com/package/@dschz/solid-create-script)
[](https://bundlephobia.com/package/@dschz/solid-create-script)
[](https://jsr.io/@dschz/solid-create-script)
[](https://github.com/dsnchz/solid-create-script/actions/workflows/ci.yaml)
> SolidJS hook to load external scripts -- built on top of [`@dschz/load-script`](https://www.npmjs.com/package/@dschz/load-script).
## โ
Features
- ๐ Fully typed with TypeScript
- โ๏ธ Built on top of [`@dschz/load-script`](https://www.npmjs.com/package/@dschz/load-script) inheriting all the same features.
- ๐ Declarative async tracking via Solid's `createResource`
## ๐ฆ Installation
```bash
npm install solid-js @dschz/load-script @dschz/solid-create-script
pnpm install solid-js @dschz/load-script @dschz/solid-create-script
yarn install solid-js @dschz/load-script @dschz/solid-create-script
bun install solid-js @dschz/load-script @dschz/solid-create-script
```
> These are **peer dependencies**, so you must install:
>
> - `solid-js`
> - `@dschz/load-script`
## ๐ง API
### `createScript(src, options?, container?)`
Loads an external script dynamically and returns a `Resource`.
#### Parameters:
| Name | Type | Description |
| ----------- | ------------------- | ----------------------------------------------------------------- |
| `src` | `string` | Script URL (required) |
| `options` | `LoadScriptOptions` | `loadScript` options (e.g. `async`, `type`) |
| `container` | `HTMLElement` | HTML element to append `` to (default: `document.head`) |
## ๐งช Example
```ts
import { Switch, Match } from "solid-js";
import { createScript } from "@dschz/solid-create-script";
const CustomComponent = () => {
const script = createScript("https://example.com/widget.js", { async: true });
return (
Loading Script...
Failed to load
Script is ready!
);
};
```
## ๐ Notes
- Scripts are cached by `src` unless `innerHTML` or `textContent` is used
- Scripts are not automatically removed on cleanup/unmount
- Designed to be simple and safe to use inside SolidJS components (in SSR and non-SSR environments)
## ๐ฌ Feedback & Contributions
Feel free to open [issues](https://github.com/dsnchz/solid-create-script/issues) or submit pull requests. PRs are welcome!