Pts
Pts 是一个用于可视化和创意编程的 TypeScript/JavaScript 库。
从 ptsjs.org 开始使用。
请尝试使用,提交问题,并向 @williamngan 发送反馈。谢谢!
使用方法
选项 1
获取最新的 pts.js
或 pts.min.js
(在 dist 文件夹中)。或者使用 CDN 服务,如 cdnjs、jsdelivr 或 unpkg。然后将其添加到您的 HTML 页面中,如下所示:
<script type="text/javascript" src="path/to/pts.js"></script>
Pts 非常轻量。目前压缩后约 100kb,gzip 压缩后 30kb。
选项 2:
通过 npm install pts
安装。然后您可以根据需要选择导入 Pts 的某些部分到您的项目中。
import {CanvasSpace, Pt, Group, Line} from 'pts';
要快速入门,请尝试下载或克隆这些仓库:
- pts-starter-kit:使用 npm 和 webpack 开始一个示例应用
- pts-react-example:尝试一个将 Pts 与 React 结合使用的示例
- react-pts-canvas:通过扩展 react-pts-canvas 组件在 React 项目中使用它
入门 阅读指南并查看演示及其源代码。 如果您需要帮助,请随时提交问题。
开发
Pts 使用 TypeScript 编写。您可以克隆或分叉此项目并按以下方式构建:
构建和测试
克隆此仓库并通过 npm install
安装依赖项。
npm start
npm run build
npm test
生成文档
运行以下命令生成 Pts 风格的文档。(需要 Python 3.6)
npm run docs
如果您更喜欢生成默认的 typedocs,请运行以下命令:
typedoc --readme none --out typedocs src --name Pts
贡献
我们感谢您的支持和反馈!
如果您发现错误或有功能请求,请提交问题。如果您能发送小的 PR 来改进 Pts 或修复错误,那就太棒了。
对于较大的 PR,请先与 @williamngan 讨论。
许可证
Apache 许可证 2.0。详情请参阅 LICENSE 文件。 版权所有 © 2017-今天,由 William Ngan 和贡献者所有。