Tldrawlignin NPM

tldraw

Welcome to the public monorepo for tldraw.

What is tldraw?

tldraw is a collaborative digital whiteboard available at tldraw.com. Its editor, user interface, and other underlying libraries are open source and available in this repository. They are also distributed on npm. You can use tldraw to create a drop-in whiteboard for your product or as the foundation on which to build your own infinite canvas applications.

Learn more at tldraw.dev.

Note This repo contains source code for the current version of tldraw. You can find the source for the original version here.

Installation & Usage

To learn more about using tldraw in your React application, follow our guide here or see the examples sandbox.

import { Tldraw } from '@tldraw/tldraw'
import '@tldraw/tldraw/tldraw.css'

export default function () {
	return (
		<div style={{ position: 'fixed', inset: 0 }}>
			<Tldraw />
		</div>
	)
}

Local development

To run the local development server, first clone this repo.

Install dependencies:

yarn

Start the local development server:

yarn dev

Open the example project at localhost:5420.

Examples

Our development server contains several examples that demonstrates different ways that you can customize tldraw or use its APIs. Each example is found in the apps/examples folder.

eg: localhost:5420 for the basic example.
eg: localhost:5420/api for the API example.

To learn more about using tldraw, visit our docs.

About this repository

Top-level layout

This repository's contents is divided across four primary sections:

/apps contains the source for our applications
/packages contains the source for our public packages
/scripts contains scripts used for building and publishing
/assets contains icons and translations relied on by the app
/docs contains the content for our docs site at tldraw.dev

Applications

examples: our local development / examples project
vscode: our Visual Studio Code extension

Packages

assets: a library for working with tldraw's fonts and translations
editor: the tldraw editor
state: a signals library, also known as signia
store: an in-memory reactive database
tldraw: the main tldraw package containing both the editor and the UI
tlschema: shape definitions and migrations
utils: low-level data utilities shared by other libraries
validate: a validation library used for run-time validation

Community

Have questions, comments or feedback? Join our discord or start a discussion.

Distributions

You can find tldraw on npm here.

At the moment the tldraw package is in alpha. We also ship a canary version which is always up to date with the main branch of this repo.

License

The source code for various apps and packages in this repository (as well as our 2.0+ distributions and releases) are currently licensed under Apache-2.0. These licenses are subject to change in our upcoming 2.0 release. If you are planning to use tldraw in a commercial product, please reach out at hello@tldraw.com.

Contribution

Please see our contributing guide. Found a bug? Please submit an issue.

Contact

Find us on Twitter at @tldraw or email hello@tldraw.com. You can also join our discord for quick help and support.

abab abbrev abstract-leveldown accepts acorn acorn-globals acorn-jsx acorn-walk agent-base agentkeepalive aggregate-error ahocorasick ajv ansi-colors ansi-escapes ansi-regex ansi-styles anymatch aproba are-we-there-yet arg argparse aria-hidden aria-query array-back array-buffer-byte-length array-flatten array-includes array-union array-uniq array.prototype.flat array.prototype.flatmap array.prototype.tosorted asn1js assert ast-types astral-regex astring async-limiter async-listen async-sema asynckit author-regex auto available-typed-arrays await-to-js azure-devops-node-api babel-jest babel-plugin-istanbul babel-plugin-jest-hoist babel-plugin-polyfill-corejs2 babel-plugin-polyfill-corejs3 babel-plugin-polyfill-regenerator babel-preset-current-node-syntax babel-preset-jest bail balanced-match base64-arraybuffer-es6 base64-js before-after-hook benchmark big.js binary-extensions bindings bl body-parser boolbase bottleneck brace-expansion braces browser-process-hrtime browser-stdout browserify-zlib browserslist bser buffer buffer-crc32 buffer-from bytes cac cacache cacheable-lookup cacheable-request call-bind callsites camelcase caniuse-lite canvas-size chalk char-regex character-entities character-entities-html4 character-entities-legacy character-reference-invalid chardet cheerio cheerio-select chokidar chokidar-cli chownr ci-info cjs-module-lexer classnames clean-stack cli-cursor cli-spinners cli-truncate cli-width cliui clone clone-response co code-block-writer collect-v8-coverage color-convert color-name color-support colorette colors combined-stream comma-separated-tokens command-line-application command-line-args command-line-usage commander concat-map concurrently config console-control-strings content-disposition content-type convert-hrtime convert-source-map cookie cookie-signature core-js core-js-compat core-util-is cosmiconfig create-require create-serve cross-fetch cross-spawn css-select css-tree css-what css.escape cssesc cssfontparser csso cssom cssstyle csstype data-uri-to-buffer data-urls date-fns deasync debug decamelize decimal.js decode-named-character-reference decompress-response dedent deep-equal deep-extend deep-is deep-object-diff deepmerge defaults defer-to-connect deferred-leveldown define-properties degenerator delayed-stream delegates depd deprecation dequal destroy detect-indent detect-libc detect-newline detect-node-es diff diff-sequences dir-glob doctrine dom-accessibility-api dom-serializer domelementtype domexception domhandler domutils dotenv duplexify dynamic-dedupe eastasianwidth edge-runtime ee-first electron-to-chromium emittery emoji-regex emojis-list encodeurl encoding encoding-down end-of-stream endent enhanced-resolve enquirer entities env-ci env-paths err-code errno error-ex es-abstract es-get-iterator es-set-tostringtag es-shim-unscopables es-to-primitive es6-object-assign esbuild esbuild-windows-64 escalade escape-html escape-string-regexp escodegen eslint eslint-config-prettier eslint-import-resolver-node eslint-module-utils eslint-plugin-import eslint-plugin-local eslint-plugin-no-only-tests eslint-plugin-react eslint-plugin-react-hooks eslint-scope eslint-visitor-keys espree esprima esquery esrecurse estraverse estree-util-attach-comments estree-util-build-jsx estree-util-is-identifier-name estree-util-value-to-estree estree-util-visit estree-walker esutils etag eval eventemitter3 execa exit exit-hook expand-template expect express extend extend-shallow external-editor fake-indexeddb fast-deep-equal fast-glob fast-json-parse fast-json-stable-stringify fast-levenshtein fastq fault fb-watchman fd-slicer figures file-entry-cache file-uri-to-path fill-range finalhandler find-replace find-up flat flat-cache flatted for-each form-data format forwarded fp-ts fresh fromentries fs-constants fs-extra fs-minipass fs.realpath ftp function-bind function.prototype.name functions-have-names gauge generic-names gensync get-caller-file get-intrinsic get-monorepo-packages get-nonce get-package-type get-port get-stream get-symbol-description get-tsconfig get-uri git-hooks-list github-from-package gitlog glob glob-parent glob-to-regexp globals globalthis globby gopd got graceful-fs grapheme-splitter gray-matter growl gunzip-maybe has has-bigints has-flag has-property-descriptors has-proto has-symbols has-tostringtag has-unicode hast-util-to-estree hast-util-whitespace he hosted-git-info hotkeys-js html-encoding-sniffer html-escaper htmlparser2 http-cache-semantics http-errors http-proxy-agent http2-wrapper https-proxy-agent human-signals humanize-ms husky iconv-lite icss-utils idb ieee754 ignore immediate import-cwd import-fresh import-from import-lazy import-local imurmurhash indent-string infer-owner inflight inherits ini inline-style-parser inquirer internal-slot invariant io-ts ip ipaddr.js is-alphabetical is-alphanumerical is-arguments is-array-buffer is-arrayish is-bigint is-binary-path is-boolean-object is-buffer is-callable is-ci is-core-module is-date-object is-decimal is-deflate is-extendable is-extglob is-fullwidth-code-point is-generator-fn is-generator-function is-glob is-gzip is-hexadecimal is-interactive is-lambda is-map is-nan is-negative-zero is-number is-number-object is-path-inside is-plain-obj is-plain-object is-potential-custom-element-name is-reference is-regex is-set is-shared-array-buffer is-stream is-string is-symbol is-typed-array is-unicode-supported is-weakmap is-weakref is-weakset isarray isexe isomorphic.js istanbul-lib-coverage istanbul-lib-instrument istanbul-lib-report istanbul-lib-source-maps istanbul-reports java-properties javascript-stringify jest jest-canvas-mock jest-changed-files jest-circus jest-cli jest-config jest-diff jest-docblock jest-each jest-environment-jsdom jest-environment-node jest-get-type jest-haste-map jest-leak-detector jest-matcher-utils jest-message-util jest-mock jest-pnp-resolver jest-regex-util jest-resolve jest-resolve-dependencies jest-runner jest-runtime jest-snapshot jest-util jest-validate jest-watcher jest-worker jju js-sdsl js-tokens js-yaml jsdom jsesc json-buffer json-parse-better-errors json-parse-even-better-errors json-schema-to-ts json-schema-traverse json-stable-stringify-without-jsonify json5 jsonc-parser jsonfile jsx-ast-utils keytar keyv kind-of kleur lazyrepo level level-codec level-concat-iterator level-errors level-iterator-stream level-js level-packager level-supports leveldown levelup leven levn lib0 lilconfig lines-and-columns linkify-it lint-staged listr2 load-json-file loader-utils locate-path lodash lodash.camelcase lodash.chunk lodash.debounce lodash.get lodash.isequal lodash.merge lodash.throttle lodash.uniq log-symbols log-update longest-streak loose-envify lowercase-keys lru-cache ltgt lz-string magic-string make-dir make-error make-fetch-happen makeerror markdown-extensions markdown-it mdast-util-definitions mdast-util-from-markdown mdast-util-frontmatter mdast-util-mdx mdast-util-mdx-expression mdast-util-mdx-jsx mdast-util-mdxjs-esm mdast-util-phrasing mdast-util-to-hast mdast-util-to-markdown mdast-util-to-string mdn-data mdurl meant media-query-parser media-typer merge-descriptors merge-stream merge2 methods micromark micromark-core-commonmark micromark-extension-frontmatter micromark-extension-mdx-expression micromark-extension-mdx-jsx micromark-extension-mdx-md micromark-extension-mdxjs micromark-extension-mdxjs-esm micromark-factory-destination micromark-factory-label micromark-factory-mdx-expression micromark-factory-space micromark-factory-title micromark-factory-whitespace micromark-util-character micromark-util-chunked micromark-util-classify-character micromark-util-combine-extensions micromark-util-decode-numeric-character-reference micromark-util-decode-string micromark-util-encode micromark-util-events-to-acorn micromark-util-html-tag-name micromark-util-normalize-identifier micromark-util-resolve-all micromark-util-sanitize-uri micromark-util-subtokenize micromark-util-symbol micromark-util-types micromatch mime mime-db mime-types mimic-fn mimic-response min-indent minimatch minimist minipass minipass-collect minipass-fetch minipass-flush minipass-pipeline minipass-sized minizlib mkdirp mkdirp-classic mlly module-alias moo-color mri ms mute-stream nanoid napi-build-utils napi-macros natural-compare natural-compare-lite negotiator nested-error-stacks netmask node-abi node-addon-api node-fetch node-gyp node-gyp-build node-int64 node-releases nopt normalize-path normalize-url npm-run-path npmlog nth-check nwsapi object-assign object-inspect object-is object-keys object.assign object.entries object.fromentries object.hasown object.values objectorarray on-finished once onetime optionator ora os-homedir os-tmpdir outdent p-cancelable p-limit p-locate p-map p-try pac-proxy-agent pac-resolver pako parent-module parse-author parse-entities parse-github-url parse-json parse-ms parse-semver parse5 parse5-htmlparser2-tree-adapter parseurl path-browserify path-exists path-is-absolute path-key path-parse path-scurry path-to-regexp path-type pathe peek-stream pend performance-now periscopic picocolors picomatch pidtree pify pirates pkg-conf pkg-dir pkg-types platform playwright-core postcss postcss-discard-duplicates postcss-load-config postcss-modules postcss-modules-extract-imports postcss-modules-local-by-default postcss-modules-scope postcss-modules-values postcss-selector-parser postcss-value-parser prebuild-install prelude-ls prettier prettier-plugin-organize-imports pretty-bytes pretty-format pretty-ms process process-nextick-args promise-inflight promise-retry prompts prop-types property-information proxy-addr proxy-agent proxy-from-env prr psl pump pumpify punycode pvtsutils pvutils qs querystringify queue-microtask quick-lru raf randombytes range-parser raw-body rc react react-dom react-is react-refresh react-remove-scroll react-remove-scroll-bar react-router react-router-dom react-shallow-renderer react-style-singleton react-test-renderer read readable-stream readdirp realistic-structured-clone recast redent reduce-flatten regenerate regenerate-unicode-properties regenerator-runtime regenerator-transform regexp.prototype.flags regexpu-core registry-url regjsparser remark-frontmatter remark-mdx-frontmatter remark-parse remark-rehype remove-markdown require-directory require-from-string require-like require-main-filename requireg requires-port resize-observer-polyfill resolve resolve-alpn resolve-cwd resolve-from resolve.exports responselike restore-cursor retry reusify rfdc rimraf rollup rollup-plugin-inject rollup-plugin-node-polyfills rollup-pluginutils run-async run-parallel rxjs sade safe-buffer safe-regex-test safer-buffer sax saxes scheduler section-matter semver send serialize-javascript serve-static set-blocking set-cookie-parser setprototypeof shebang-command shebang-regex shell-quote side-channel signal-exit signale simple-concat simple-get sisteransi slash slice-ansi smart-buffer socks socks-proxy-agent sort-object-keys sort-package-json source-map source-map-js source-map-support sourcemap-codec space-separated-tokens spawn-command sprintf-js ssri stack-utils statuses stop-iteration-iterator stream-shift string-argv string-hash string-length string-width string.prototype.matchall string.prototype.trim string.prototype.trimend string.prototype.trimstart stringify-entities string_decoder strip-ansi strip-bom strip-bom-string strip-final-newline strip-indent strip-json-comments style-to-object supports-color supports-hyperlinks supports-preserve-symlinks-flag svgo symbol-tree table-layout tapable tar tar-fs tar-stream terminal-link test-exclude text-table through through2 time-span tinycolor2 tldraw-vscode tmp tmpl to-fast-properties to-regex-range toidentifier toml tough-cookie tr46 tree-kill trough ts-dedent ts-loader ts-morph ts-node ts-node-dev ts-toolbelt tsconfig tsconfig-paths tslib tsutils tsx tunnel tunnel-agent type-check type-detect type-fest type-is typed-array-length typed-rest-client typescript typescript-memoize typeson typeson-registry typical uc.micro ufo unbox-primitive underscore unicode-canonical-property-names-ecmascript unicode-match-property-ecmascript unicode-match-property-value-ecmascript unicode-property-aliases-ecmascript unified unique-filename unique-slug unist-builder unist-util-generated unist-util-is unist-util-position unist-util-position-from-estree unist-util-remove-position unist-util-stringify-position unist-util-visit unist-util-visit-parents universal-user-agent universalify unpipe update-browserslist-db uri-js url-join url-parse use-callback-ref use-isomorphic-layout-effect use-sidecar user-home util util-deprecate utils-merge uvu v8-compile-cache-lib v8-to-istanbul validator vary vercel vfile vfile-location vfile-message vite vite-node vm2 vsce w3c-hr-time w3c-xmlserializer walker wcwidth web-vitals webcrypto-core webidl-conversions whatwg-encoding whatwg-mimetype whatwg-url which which-boxed-primitive which-collection which-module which-typed-array wide-align word-wrap wordwrapjs workerpool wrap-ansi wrappy write-file-atomic ws xdm xml-name-validator xml2js xmlbuilder xmlchars xregexp xtend y-leveldb y-protocols y-websocket y18n yallist yaml yargs yargs-parser yargs-unparser yauzl yazl yjs yn yocto-queue z-schema zod zod-validation-error zwitch

@everything-registry/sub-chunk-2952

1.0.1

9 months ago

1.0.0

9 months ago