aesthetically v0.0.6

Table of Contents

• Table of Contents
• Demo
• Installation
• Usage
  • Getting a list of styles
  • Styling test
  • Un-styling text
  • Table of styles and support
• Acknowledgements
• License

Demo

Check out the demo.

Installation

Using jsDelivr:

As an ES6 module:

<script type="module">
  import Aesthetically from "https://cdn.jsdelivr.net/npm/aesthetically@0/dist/aesthetically.js";
</script>

As a normal script:

<script src="https://cdn.jsdelivr.net/npm/aesthetically@0/dist/aesthetically.umd.js"></script>

Self-hosted:

As an ES6 module:

<script type="module">
  import Aesthetically from "/aesthetically.js";
</script>

As a normal script:

<script src="/aesthetically.umd.js"></script>

Using npm:

$ npm i aesthetically

In Node:

As an ES6 module:

import Aesthetically from "aesthetically";

As a CommonJS module:

const Aesthetically = require("aesthetically");

Usage

Getting a list of styles

If your looking for a list of styles, take a look at the table below

styles = Object.keys(Aesthetically.styles);

Styling test

Aesthetically.format("this is v cool", "double-struck");
// "this is v cool"

Arguments

text: (String) text to transform

style: (String) Style to transform text to

Returns

(String) formatted text

Un-styling text

Aesthetically.unformat("𝓹𝓪𝓬𝓶𝓪𝓷 𝓲𝓼 𝓱𝓾𝓷𝓰𝓻𝔂 👾🍔");
// "pacman is hungry 👾🍔"

Arguments

text: (String) text to transform

Returns

(String) unstyled text

Table of styles and support

Not all styles support all types of characters. Some only support lowercase or uppercase. Digits indicate support for 1 - 9 while zero is listed sperately if supported.

Mathematical Alphanumeric Symbols

Enclosed Alphanumerics & Supplement

Acknowledgements

This article and this other article were really useful for understanding the way Unicode strings work in JavaScript. The demo uses the awesome Bulma CSS framework <3.

License

MIT License

Copyright (c) 2020 Joshy Nosh

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.