https://github.com/luavolk/dart-textifier

Dart version of Textifier
https://github.com/luavolk/dart-textifier

canvas dart html text textifier textify

Last synced: about 1 month ago
JSON representation

Dart version of Textifier

• Host: GitHub
• URL: https://github.com/luavolk/dart-textifier
• Owner: luaVolk
• License: mit
• Created: 2018-12-13T19:37:21.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-01T23:30:24.000Z (almost 6 years ago)
• Last Synced: 2023-08-20T23:23:58.155Z (over 1 year ago)
• Topics: canvas, dart, html, text, textifier, textify
• Language: Dart
• Homepage:
• Size: 492 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Textifier [![Pub](https://img.shields.io/pub/v/textifier.svg)](https://pub.dartlang.org/packages/textifier)

>*Textifier is a dart library that lets you convert images to any text of your choosing, in your browser*

| Original | Colored | Grayscale | Monochrome | Console |

| --- | --- | --- | --- | --- |

| ![Original](images/piggies.png "Colored") | ![Colored](images/rendered_piggies.png "Colored") | ![Grayscale](images/grayscale_piggies.png "Grayscale") | ![Monochrome](images/monochrome_piggies.png "Monochrome") | ![Console](images/console_piggies.png "Console") |

Textifier can print as HTML an image or it can even print it in you browser's console.

## Instalation

  ```bash

  $ pub get textifier

  ```

## Usage

  Here is the mandatory one-liner to show how simple it can be.

  ```dart

  new Textifier().draw('images/piggies.png', target);

  ```

  Of course you are probably going to want use some options. Textifier takes a few optional named arguments.

### :warning: NOTES :warning:

  Textifier needs CORS access to the source images.

### optional arguments

Every other option will be in the option object.

  | Names | Defaults | Types | Info

  | --- | --- | --- | ---

  | maxWidth | `Infinity` | `String\|num`  | maxWidth should be a positive number. This sets maximum width of the rendered image. If it is not set or set with an invalid value, it will take as much space as it can.
Valid values are either a number or a valid CSS size value (e.g `200px`).
Unless specified units will be measured in characters.

  | maxHeight | `Infinity` | `String\|num`  | Same as maxWidth except that if it is not set the maximum height will be the the same as the height of the original image but in characters instead of pixels.

  | characters | `"01"` | `String`  | The character list to write the image with.

  | background | `"#00000000"` | `String`   | Color of the background. This color will also be rendered in text.

  | ordered | `false` | `bool`  | If true the characters will show up in order of the `characters` string

  | color | `0` | `int` | If the image should be colored, in grayscale or monochrome
`0 = colored`
`1 = grayscale`
`2 = monochrome`
Textifier comes with some [constants](#constants) so you don't have to memorize this

## Functions

  There are 3 main functions in Textifier, write, draw and log. There a few other mainly used internally but available anyways since they might come in handy.

### write, draw

  `arguments: (String url, Element element, bool append)`

  The `write` and `draw` functions work exactly the same way. The only difference is that `write` will print html in a \
 tag and the `draw` will print an actual image on a canvas.

#### url

  `type: String`


  The url of the image to be used.

#### element

  `type: Element`

  The element in which the rendered image will be added to.

#### append

  `type: bool`

  If the rendered image should be appended or replace the contents of the target `element`.

##### **Example**

  ```dart

  new Textifier(maxWidth: 100, characters: 'oink', ordered: true).draw('images/piggies.png', target);

  ```

##### Output

  ![Rendered image](images/rendered_piggies.png "Rendered image")

### log

  `arguments: (String url)`

  The `log` function will print the image in the dev console of your browser.

#### url

  `type: String`

  The url of the image to be used.

##### **Example**

  ```dart

  new Textifier(maxWidth: 100, characters: 'oink', ordered: true).log('images/piggies.png');

  ```

##### Output

  ![Rendered image](images/console_piggies.png "Rendered image")

## Constants

  Textifier comes with some "constants" so you don't have to remember arguments that are numbers and to make your code more readable.

  ```dart

  Textifier.COLORED = 0;

  Textifier.GRAYSCALE = 1;

  Textifier.MONOCHROME = 2;

  ```

## License

   [MIT License](LICENSE.md)