Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/file2html/file2html
JS convertor of files to HTML and CSS code
https://github.com/file2html/file2html
filereader files js ooxml reading
Last synced: 3 months ago
JSON representation
JS convertor of files to HTML and CSS code
- Host: GitHub
- URL: https://github.com/file2html/file2html
- Owner: file2html
- License: mit
- Archived: true
- Created: 2017-06-02T12:19:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-28T06:29:25.000Z (over 4 years ago)
- Last Synced: 2024-08-20T07:43:57.758Z (4 months ago)
- Topics: filereader, files, js, ooxml, reading
- Language: TypeScript
- Size: 65.4 KB
- Stars: 31
- Watchers: 6
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# file2html
[](https://travis-ci.org/file2html/file2html)[](https://www.npmjs.com/package/file2html)
[](https://www.npmjs.com/package/file2html)
[](https://www.npmjs.com/package/file2html)
[](https://coveralls.io/github/file2html/file2html?branch=master)
> JS convertor of files to HTML and CSS code
## Requirements
* [Promise API](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise), [polyfill](https://github.com/lahmatiy/es6-promise-polyfill)
* [Encoding API](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API), [polyfill](https://github.com/inexorabletash/text-encoding)
* [Object.assign](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign), [polyfill](https://github.com/ljharb/object.assign)
## Supported formats
- [x] Text [file2html-text](https://github.com/file2html/file2html-text) (.txt)
- [x] Images [file2html-image](https://github.com/file2html/file2html-image) (.png, .jpg, .gif, .svg, .ico, .wbmp)
- [x] OOXML Documents [file2html-ooxml](https://github.com/file2html/file2html-ooxml) (.docx)
- [ ] OOXML Presentations (.pptx)
- [ ] OOXML Spreadsheets (.xlsx)
- [x] ODF Text Files [file2html-odf](https://github.com/file2html/file2html-odf) (.odt)
- [x] DSV [file2html-dsv](https://github.com/file2html/file2html-dsv) (.csv, .tsv)
- [x] FictionBook [file2html-fiction-book](https://github.com/file2html/file2html-fiction-book) (.fb2)
- [x] EPUB [file2html-epub](https://github.com/file2html/file2html-epub) (.epub)
- [ ] DjVu (.djvu, .djv)
- [ ] RTF (.rtf)
- [ ] WCBFF (.doc)
## Usage
### Installation
```shell
> npm i file2html
```
### Installation of required engines for each file type:
```shell
> npm i file2html-text file2html-ooxml file2html-image
```
Check [supported formats](#supported-formats) to decide which engines you need.
### Configuration
```js
import * as file2html from 'file2html';
import TextReader from 'file2html-text';
import OOXMLReader from 'file2html-ooxml';
import ImageReader from 'file2html-image';
file2html.config({
readers: [
TextReader,
OOXMLReader,
ImageReader
]
});
```
### File reading
```js
file2html.read({
fileBuffer, // ArrayBuffer
meta // file2html.FileMetaInformation
}).then((file) => {
// file is an instance of file2html.File type
const {styles, content} = file.getData();
// "render" a file content with styles
document.body.innerHTML = styles + content;
});
```
#### FileMetaInformation
```js
{
fileType: number; // optional
mimeType: string; // optional
name: string; // optional
size: number; // optional
creator: string; // optional
createdAt: string; // optional
modifiedAt: string; // optional
}
```
#### File
```js
{
getMeta () {
// returns object of file2html.FileMetaInformation
}
getData () {
// returns object of file2html.FileData
}
}
```
#### FileData
```js
{
meta: file2html.FileMetaInformation;
styles: string; // css styles as a string
content: string; // html markup as a string
}
```
## Showcase
### StormFiles
Browser extension, file viewer:
* [Chrome extension](https://chrome.google.com/webstore/detail/stormfiles/ickghndjocahgacnfaakbmbokmfneahd)
* [Firefox extension](https://addons.mozilla.org/firefox/addon/stormfiles)