@sqwig/core
v1.10.4
Published
The text box with spellcheck built in. Drop-in rich text editor with fully client-side dictionary spellcheck — text never leaves the browser.
Maintainers
Readme
@sqwig/core
The text box with spellcheck built in. Finally.
Sqwig is a drop-in rich text editor with dictionary spellcheck that runs entirely in the browser — a WASM engine and dictionary served as static files from your origin. User text is not transmitted, and the component makes no calls to Sqwig servers. If the dictionary fails to load, the editor degrades to a plain rich text input rather than blocking your users.
- ✅ Live red squiggles as users type; tap/click for suggestions, Ignore, Add to dictionary
- ✅ Word-tier toolbar: bold/italic/underline/strike, headings, fonts & sizes, lists, alignment, line spacing, links, undo/redo
- ✅ Clean paste from Word and Google Docs — clean semantic HTML out
- ✅ Pasted a PDF? Paste keeps it exactly as copied; one Clean up text click rebuilds the paragraphs, lists and headings (and one Ctrl+Z puts it back)
- ✅ Supported on mobile: iOS Safari + Android Chrome, native-autocorrect interplay handled, ≥40px touch targets
- ✅ Spellcheck runs in a Web Worker — no main-thread jank (Lighthouse mobile 100)
- ✅ Light & dark themes, fully themeable via CSS custom properties
- ✅ Framework-agnostic; official React wrapper:
@sqwig/react
Install
npm install @sqwig/coreQuick start
Serve the spell assets (spell_wasm_bg.wasm, spell.worker.js, dict/)
from a static folder — or copy the whole dist/ and use the defaults:
import { createEditor, createSpellChecker } from "@sqwig/core";
const editor = createEditor(document.getElementById("editor"), {
placeholder: "Say something…",
spell: createSpellChecker({ assetBaseUrl: "/sqwig/" }),
trustIndicator: { wordCount: true },
license: "free", // accepts the Sqwig Free License — sqwig.com/free-license
});
editor.on("change", () => save(editor.getHTML()));Output is always a clean, whitelisted semantic subset — safe to store and re-render.
Try the paid features free for 30 days
Word export, PDF export, a custom dictionary and no badge, for 30 days. Give us an email address and the key comes back by email: Start a 30-day trial
A trial is for evaluation, not commercial production. On day 31 the key expires,
the paid features lock and the editor keeps working; pass license: "free" to
return to the clean badge.
Documentation
Full guides (vanilla, React, Angular, ASP.NET Core, Blazor), the complete options/API reference, and theming: Read the documentation
Security
Found a vulnerability? Email [email protected] with the version and a minimal proof of concept. Policy: Security FAQ
License
Commercial software. LICENSE.txt in this package and the
Terms of Service are the governing documents — the summary below is
for orientation and does not replace them.
The license option is required, and all three states run the full core editor:
- omitted — the full editor, a "Powered by Sqwig · unlicensed" badge, one console note
"free"— the Free tier: one application, clean badge. Covers development, evaluation and non-commercial production; a commercial application in production requires a paid plan. Setting it accepts the Sqwig Free License- a signed key — your tier's entitlements; the badge is removed on paid tiers
Keys are verified offline — no license server, no phone-home, no usage metering, no per-developer fees. Verification is fail-open: an invalid, malformed or expired key degrades to the Free tier with the badge and a console note. Licensing does not break the editor and the runtime does not throw over it; paid plans additionally enable the features we designate as paid.
Nuances that affect what a license covers — term-bound keys, hostname
matching, free development hosts, and packaged app shells (Electron, Capacitor,
browser extensions run on the Free tier) — are set out in CHANGELOG.md and in the
license notes. Pricing: Plans and pricing
No warranty; provided "as is" to the extent permitted by law. Spellcheck is an
automated aid, and Sqwig's sanitisation is not a substitute for re-sanitising
server-side. Third-party notices: THIRD_PARTY_LICENSES.txt and
dist/dict/LICENSE.SCOWL.
