Skip to content
This repository has been archived by the owner on Mar 13, 2021. It is now read-only.

Binder Editor is a whiteboard tool that lets you easily sketch diagrams that have a hand-drawn feel to them.

License

Notifications You must be signed in to change notification settings

marcelovicentegc/binder-editor

Repository files navigation

📓 binder-editor

npm version

📦 Installation

npm i @binder/editor

yarn add @binder/editor

🔨 Usage

import { BinderEditor, TopErrorBoundary } from "@binder/editor";
import { ThemeProvider, theme } from "@binder/ui";

const App = () => {
  return (
    <ThemeProvider theme={theme}>
      <TopErrorBoundary>
        <BinderEditor
          title={"Angiosperms"}
          actions={{
            backButton: {
              label: "Back",
              buttonProps: {
                onClick: () => alert("🚀🚀🚀🚀🚀🚀🚀"),
              },
            },
          }}
          toolbarProps={{
            textColor: {
              menuTitle: "Text color",
            },
            textBoxColor: {
              menuTitle: "Text box color",
            },
            textBoxStyle: {
              menuTitle: "Text box style",
            },
          }}
        />
      </TopErrorBoundary>
    </ThemeProvider>
  );
};

⬆️ Development directions

  1. Clone this repo: git clone https://github.com/marcelovicentegc/binder-editor.git
  2. cd into it: cd binder-editor
  3. Install its dependencies (use npm): npm i
  4. Run the application: npm start

🤝 Contributing

  1. Create your own branch from develop
  2. Make the changes you wish
  3. Write or rewrite the unit tests, if necessary
  4. Open a pull request pointing to develop
  5. That's it! 🤓

About

Binder Editor is a whiteboard tool that lets you easily sketch diagrams that have a hand-drawn feel to them.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published