/nldraw

A native wrapper for tldraw

Primary LanguageTypeScriptMIT LicenseMIT

Nldraw (WIP)

A native wrapper for tldraw

Description

This project is a quick note-taking and sketching tool built on top of the tldraw library. It provides a simple interface for users to jot down notes and create sketches on-the-go. With a focus on offline usage, this tool allows users to store and access their data locally, eliminating the need for constant communication with a remote server. Whether you're in a remote area with limited internet connectivity or simply prefer to keep your data local, this project offers the flexibility to work offline using the local filesystem.

Please note that this project is intended for personal use and experimentation. It is not actively maintained, and none of the features mentioned in the roadmap are currently scheduled for development.

Features

WIP

All the files are stored in the public Documents folder with the name Nldraw.

  • Use tldraw snapshot with native filesystem instead of localStorage.

Screenshots

WIP

Installation

WIP

Build it your self

Check Capacitor for more details.

Roadmap

WIP

  • Open/Save draws in default location.
  • App configuration.
    • Custom default location.
    • Toggle color scheme (light,dark).
    • Privacy screen (prevent screenshots).
    • Biometric authentication.
    • Default behavior for tldraw.
  • Modify web specific features of tldraw.
    • Remove native incompatible features.
    • Re-implement removed features.
  • Replace attachments embedding with reference links. (broke tldraw format)
  • Use custom component to render linked attachments (image,voice,...).
  • Apply template from existing draws.
  • Support filter draws or groups
    • Search using tags.
    • Search text inside draws.
  • Update notification.
  • Desktop support.
  • IOS support. (no promised)

Core Libraries

Client: React, Ant Design Mobile, Tldraw.

Native: Capacitor.

Contributing

This project is not actively seeking contributions at the moment. However, if you have any bug reports or suggestions, feel free to open an issue in the repository.

License

Third-Party Libraries

  • tldraw is used as the underlying library for the sketching functionality. Please refer to the tldraw repository for more information about its license and usage.

FAQ