Skip to content

docs: #232 document signals typescript support #265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thescientist13 merged 1 commit into from
Apr 18, 2026
Merged

docs: #232 document signals typescript support #265

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 22 additions & 1 deletion docs/pages/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,8 @@ So taking the above counter example, enable the inferred observability behavior

<!-- prettier-ignore-end -->

#### Signals Support

It is required to setup `Signal` as a global in the browser, and add import maps for the polyfill and WCC's `effect` function in the `<head>` of your HTML page(s):

<!-- prettier-ignore-start -->
Expand All @@ -646,7 +648,26 @@ It is required to setup `Signal` as a global in the browser, and add import maps

<!-- prettier-ignore-end -->

Some notes / limitations:
For TypeScript support, you'll need to expose the Signal type-definition globally:

<!-- prettier-ignore-start -->

<wcc-ctc-block variant="snippet" heading="src/globals.d.ts">

```ts
// alias Signal to avoid name conflicts with the global Signal type
import { Signal as SignalInterface } from "signal-polyfill";

declare global {
const Signal: typeof SignalInterface;
}
```

</wcc-ctc-block>

<!-- prettier-ignore-end -->

#### Limitations

- Reactivity is [only supported at one depth of the JSX tree](https://github.com/ProjectEvergreen/wcc/issues/256)
- Please be aware of the above linked discussion and issue filter which is tracking any known bugs / feature requests / open items related to all things WCC + JSX.
Expand Down