UNPKG

1.05 kBTypeScriptView Raw
1import { Configuration } from 'twind';
2export * from 'twind';
3
4/**
5 * [[include:src/shim/README.md]]
6 *
7 * @packageDocumentation
8 * @module twind/shim
9 */
10
11/**
12 * Options for {@link setup}.
13 */
14interface ShimConfiguration extends Configuration {
15 /**
16 * The root element to shim (default: `document.documentElement`).
17 */
18 target?: HTMLElement;
19}
20/**
21 * Stop shimming/observing all nodes.
22 */
23declare const disconnect: () => void;
24/**
25 * Configure the default {@link tw} and starts {@link observe | observing} the
26 * {@link ShimConfiguration.target | target element} (default: `document.documentElement`).
27 *
28 * You do not need to call this method. As an alternativ you can provide a
29 * `<script type="twind-config">...</script>` element within the document.
30 * The content must be valid JSON and all {@link twind.setup | twind setup options}
31 * (including hash) are supported.
32 */
33declare const setup: ({ target, ...config }?: ShimConfiguration) => void;
34
35export { ShimConfiguration, disconnect, setup };
36//# sourceMappingURL=shim.d.ts.map