Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nteract/ansi-to-react
:guardsman: ANSI to React
https://github.com/nteract/ansi-to-react
Last synced: about 2 months ago
JSON representation
:guardsman: ANSI to React
- Host: GitHub
- URL: https://github.com/nteract/ansi-to-react
- Owner: nteract
- Created: 2016-03-19T20:50:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-24T17:26:44.000Z (over 1 year ago)
- Last Synced: 2024-07-28T17:43:28.697Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 2.14 MB
- Stars: 89
- Watchers: 35
- Forks: 30
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ansi-to-react
This package convert ANSI escape codes to formatted text output for React.
## Installation
```
$ yarn add ansi-to-react
```
```
$ npm install --save ansi-to-react
```
## Usage
### Basic
The example below shows how we can use this package to render a string with ANSI escape codes.
```javascript
import Ansi from "ansi-to-react";
export function () => {
return
{'\u001b[34mhello world'}
;
};
```
Will render:
```javascript
hello world
```
### Classes
Style with classes instead of `style` attribute.
```javascript
{"\u001b[34mhello world"}
```
Will render
```javascript
hello world
```
#### Class Names
| Font color | Background Color |
| ---------------------- | ---------------- |
| ansi-black-fg | ansi-black-bg |
| ansi-red-fg | ansi-red-bg |
| ansi-green-fg | ansi-green-bg |
| ansi-yellow-fg | ansi-yellow-bg |
| ansi-blue-fg | ansi-blue-bg |
| ansi-magenta-fg | ansi-magenta-bg |
| ansi-cyan-fg | ansi-cyan-bg |
| ansi-white-fg | ansi-white-bg |
| ansi-bright-black-fg |
| ansi-bright-red-fg |
| ansi-bright-green-fg |
| ansi-bright-yellow-fg |
| ansi-bright-blue-fg |
| ansi-bright-magenta-fg |
| ansi-bright-cyan-fg |
| ansi-bright-white-fg |
## Development
To develop on this project, fork and clone this repository on your local machine. Before making modifications, install the project's dependencies.
```
$ npm install
```
To run the test suite for this project, run:
```
$ npm test
```
## Documentation
We're working on adding more documentation for this component. Stay tuned by watching this repository!
## Support
If you experience an issue while using this package or have a feature request, please file an issue on the [issue board](https://github.com/nteract/ansi-to-react/issues),
## License
[BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause/)