@joint/core
Advanced tools
JointJS is a tested and proven JavaScript/Typescript diagramming library that helps developers and companies of any size build visual and No-Code/Low-Code applications faster and with confidence. It’s a flexible tool from which a wide range of UIs can be created (interactive diagramming applications, drawing tools, data visualizations, UIs for monitoring systems, and many more). It can become the foundational layer of your next application and help you bring your idea to market in days, not months or years.
Further information, examples and documentation can be found at jointjs.com.
:1234: Get started with tutorials.
:bulb: To ask a question, share feedback, or engage in a discussion with other community members, visit our GitHub discussions.
:pen: More examples are available on CodePen.
:book: Check out our mind-map documentation.
If you want to work on JointJS locally, use the following guidelines to get started.
Make sure you have the following dependencies installed on your system:
Make sure that you are using Yarn version >= 2.0.0, so that you have access to Yarn workspace ranges functionality. If you are using Volta, it will automatically read this restriction from package.json.
Clone this git repository:
git clone https://github.com/clientIO/joint.git
Navigate to the joint directory:
cd joint
Install all dependencies:
yarn install
Generate distribution files from the source code:
yarn run dist
You are now ready to browse our example applications, which combine functionality from multiple JointJS packages:
cd examples
Refer to each application's README.md file for additional instructions.
You can also browse the demo applications of our JointJS Core package:
cd packages/joint-core/demo
Most demos can be run by simply opening the index.html file in your browser. Some demos have additional instructions, which you can find in their respective README.md files.
To run all tests:
yarn run test
To run only the server-side tests:
yarn run test-server
To run only the client-side tests:
yarn run test-client
To run only TypeScript tests:
yarn run test-ts
To check for linting errors in src and types directories:
yarn run lint
To auto fix errors, run eslint for src and types directories:
yarn run lint-fix
To output a code coverage report in HTML:
yarn run test-coverage
To output a code coverage report in lcov format:
yarn run test-coverage-lcov
The output for all unit tests will be saved in the packages/joint-core/coverage directory.
The source files for the JointJS documentation (plus Geometry and Vectorizer libraries) are included in this repository; see the packages/joint-core/docs directory. The documentation can be built into stand-alone HTML documents like this:
yarn run build-docs
The output of the above command can be found at packages/joint-core/build/docs.
The JointJS library is licensed under the Mozilla Public License 2.0.
Copyright © 2013-2024 client IO
FAQs
JavaScript diagramming library
The npm package @joint/core receives a total of 9,797 weekly downloads. As such, @joint/core popularity was classified as popular.
We found that @joint/core demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.