# tojson.js

**Repository Path**: py-service/tojson.js

## Basic Information

- **Project Name**: tojson.js
- **Description**: https://github.com/haixin-fang/tojson.js
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-21
- **Last Updated**: 2024-12-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# tojson.js

tojson.js 是一个支持解析 Psd、Sketch、PPTX 转 json 的类库, 该 json 满足 fabric.js 渲染的数据格式.

# 在线体验

https://haixin-fang.github.io/tojson.js/playground

## 环境准备

playground 的示例项目，就是为开发者提供的基础应用示例。

node.js >= 16

先安装 pnpm

```bash
$ npm install -g pnpm
```

然后安装依赖

```bash
$ pnpm bootstrap
```

## 运行项目

执行命令

```bash
$ pnpm dev
```

最后在浏览器中打开

即可得到一个解析 Sketch, Psd 为 json 的项目

## 项目介绍

在本项目中，我们核心内容，是包含在 `packages/*` , 其中是解析各个文件的核心代码

- psd-json.js 解析 psd 转 json 的类库
- sketchtojson 解析 sketch 转 json 的类库
- pptx-json 解析 pptx 转 json 的类库
- tojson.js 解析 psd、sketch、pptx 转 json

### 使用

安装

```js
npm i -S tojson.js
```

或

```js
npm i -S psd-json.js
```

或

```js
npm i -S sketchtojson
```

使用

```js
import toJson, { getFileType, types as fileTypes, psdtojson, sketchtojson, pptxtojson } from "tojson.js";
const options = {
  uploadUrl: options.uploadUrl, // 图片上传的接口地址
  uploadCallback: options.uploadCallback, // 上传完成后的数据处理回调方法
};
// psd、sketch文件
const result = await toJson(files, options);
/**
 * 创建实例和解析文件分开,可以在一个实例中解析 n 个文件
 */
// 或
const instance = new pptxtojson(options);
const result = instance.init(files);
// 或
const instance = new sketchtojson(options);
const result = instance.init(files);
// 或
const instance = new pptxtojson(options);
const result = instance.init(files);
```

- getFileType 方法能获取文件类型
- types 返回支持的文件类型, 如 psd、sketch

#### sketch 文件解析

```js
import sketchtojson from "sketchtojson";
const options = {
  uploadUrl: options.uploadUrl, // 图片上传的接口地址
  uploadCallback: options.uploadCallback, // 上传完成后的数据处理回调方法
};
const instance = new sketchtojson(options);
const result = instance.init(files);
```

#### psd 文件解析

```js
import psdtojson from "psd-json.js";
const options = {
  uploadUrl: options.uploadUrl, // 图片上传的接口地址
  uploadCallback: options.uploadCallback, // 上传完成后的数据处理回调方法
};
const instance = new pptxtojson(options);
const result = instance.init(files);
```

#### pptx 文件解析

```js
import pptxtojson from "pptx-json";
const options = {
  uploadUrl: options.uploadUrl, // 图片上传的接口地址
  uploadCallback: options.uploadCallback, // 上传完成后的数据处理回调方法
};
const instance = new pptxtojson(options);
const result = instance.init(files);
```

## 未来

后续会支持的功能

- pdf 解析