\begin{quote}
Unicode symbols with Windows CMD fallbacks \end{quote}
\href{index.js}{\texttt{ }}

\href{index.js}{\texttt{ {\itshape and more...}}}

Windows CMD only supports a \href{http://en.wikipedia.org/wiki/Code_page_437}{\texttt{ limited character set}}.\hypertarget{md_sfcode_node_modules_figures_readme_autotoc_md10393}{}\doxysection{Install}\label{md_sfcode_node_modules_figures_readme_autotoc_md10393}

\begin{DoxyCode}{0}
\DoxyCodeLine{\$ npm install figures }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_figures_readme_autotoc_md10394}{}\doxysection{Usage}\label{md_sfcode_node_modules_figures_readme_autotoc_md10394}
See the \href{index.js}{\texttt{ source}} for supported symbols.


\begin{DoxyCode}{0}
\DoxyCodeLine{const figures = require('figures');}
\DoxyCodeLine{}
\DoxyCodeLine{console.log(figures('✔︎ check'));}
\DoxyCodeLine{// On non-\/Windows OSes:  ✔︎ check}
\DoxyCodeLine{// On Windows:           √ check}
\DoxyCodeLine{}
\DoxyCodeLine{console.log(figures.tick);}
\DoxyCodeLine{// On non-\/Windows OSes:  ✔︎}
\DoxyCodeLine{// On Windows:           √}
\DoxyCodeLine{}
\DoxyCodeLine{console.log(figures.main.tick);}
\DoxyCodeLine{// On all OSes:  ✔︎}
\DoxyCodeLine{}
\DoxyCodeLine{console.log(figures.windows.tick);}
\DoxyCodeLine{// On all OSes:  √ }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_figures_readme_autotoc_md10395}{}\doxysection{API}\label{md_sfcode_node_modules_figures_readme_autotoc_md10395}
\hypertarget{md_sfcode_node_modules_figures_readme_autotoc_md10396}{}\doxysubsection{figures(string)}\label{md_sfcode_node_modules_figures_readme_autotoc_md10396}
Returns the input with replaced fallback Unicode symbols on Windows.

All the below \href{\#figures}{\texttt{ figures}} are attached to the main export as shown in the example above.\hypertarget{md_sfcode_node_modules_figures_readme_autotoc_md10397}{}\doxysubsubsection{string}\label{md_sfcode_node_modules_figures_readme_autotoc_md10397}
Type\+: {\ttfamily string}

String where the Unicode symbols will be replaced with fallback symbols depending on the OS.\hypertarget{md_sfcode_node_modules_figures_readme_autotoc_md10398}{}\doxysubsection{figures.\+main}\label{md_sfcode_node_modules_figures_readme_autotoc_md10398}
Symbols to use when not running on Windows.\hypertarget{md_sfcode_node_modules_figures_readme_autotoc_md10399}{}\doxysubsection{figures.\+windows}\label{md_sfcode_node_modules_figures_readme_autotoc_md10399}
Symbols to use when running on Windows.\hypertarget{md_sfcode_node_modules_figures_readme_autotoc_md10400}{}\doxysection{Figures}\label{md_sfcode_node_modules_figures_readme_autotoc_md10400}
\tabulinesep=1mm
\begin{longtabu}spread 0pt [c]{*{3}{|X[-1]}|}
\hline
\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Name   }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Non-\/\+Windows   }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Windows    }\\\cline{1-3}
\endfirsthead
\hline
\endfoot
\hline
\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Name   }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Non-\/\+Windows   }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Windows    }\\\cline{1-3}
\endhead
tick   &\PBS\centering ✔   &\PBS\centering √    \\\cline{1-3}
cross   &\PBS\centering ✖   &\PBS\centering ×    \\\cline{1-3}
star   &\PBS\centering ★   &\PBS\centering $\ast$    \\\cline{1-3}
square   &\PBS\centering ▇   &\PBS\centering █    \\\cline{1-3}
square\+Small   &\PBS\centering ◻   &\PBS\centering \mbox{[} \mbox{]}    \\\cline{1-3}
square\+Small\+Filled   &\PBS\centering ◼   &\PBS\centering \mbox{[}█\mbox{]}    \\\cline{1-3}
play   &\PBS\centering ▶   &\PBS\centering ►    \\\cline{1-3}
circle   &\PBS\centering ◯   &\PBS\centering ( )    \\\cline{1-3}
circle\+Filled   &\PBS\centering ◉   &\PBS\centering ($\ast$)    \\\cline{1-3}
circle\+Dotted   &\PBS\centering ◌   &\PBS\centering ( )    \\\cline{1-3}
circle\+Double   &\PBS\centering ◎   &\PBS\centering ( )    \\\cline{1-3}
circle\+Circle   &\PBS\centering ⓞ   &\PBS\centering (○)    \\\cline{1-3}
circle\+Cross   &\PBS\centering ⓧ   &\PBS\centering (×)    \\\cline{1-3}
circle\+Pipe   &\PBS\centering Ⓘ   &\PBS\centering (│)    \\\cline{1-3}
circle\+Question\+Mark   &\PBS\centering ?⃝   &\PBS\centering (?)    \\\cline{1-3}
bullet   &\PBS\centering ●   &\PBS\centering $\ast$    \\\cline{1-3}
dot   &\PBS\centering ․   &\PBS\centering .    \\\cline{1-3}
line   &\PBS\centering ─   &\PBS\centering ─    \\\cline{1-3}
ellipsis   &\PBS\centering …   &\PBS\centering ...    \\\cline{1-3}
pointer   &\PBS\centering ❯   &\PBS\centering $>$    \\\cline{1-3}
pointer\+Small   &\PBS\centering ›   &\PBS\centering »    \\\cline{1-3}
info   &\PBS\centering ℹ   &\PBS\centering i    \\\cline{1-3}
warning   &\PBS\centering ⚠   &\PBS\centering ‼    \\\cline{1-3}
hamburger   &\PBS\centering ☰   &\PBS\centering ≡    \\\cline{1-3}
smiley   &\PBS\centering ㋡   &\PBS\centering ☺    \\\cline{1-3}
mustache   &\PBS\centering ෴   &\PBS\centering ┌─┐    \\\cline{1-3}
heart   &\PBS\centering ♥   &\PBS\centering ♥    \\\cline{1-3}
nodejs   &\PBS\centering ⬢   &\PBS\centering ♦    \\\cline{1-3}
arrow\+Up   &\PBS\centering ↑   &\PBS\centering ↑    \\\cline{1-3}
arrow\+Down   &\PBS\centering ↓   &\PBS\centering ↓    \\\cline{1-3}
arrow\+Left   &\PBS\centering ←   &\PBS\centering ←    \\\cline{1-3}
arrow\+Right   &\PBS\centering →   &\PBS\centering →    \\\cline{1-3}
radio\+On   &\PBS\centering ◉   &\PBS\centering ($\ast$)    \\\cline{1-3}
radio\+Off   &\PBS\centering ◯   &\PBS\centering ( )    \\\cline{1-3}
checkbox\+On   &\PBS\centering ☒   &\PBS\centering \mbox{[}×\mbox{]}    \\\cline{1-3}
checkbox\+Off   &\PBS\centering ☐   &\PBS\centering \mbox{[} \mbox{]}    \\\cline{1-3}
checkbox\+Circle\+On   &\PBS\centering ⓧ   &\PBS\centering (×)    \\\cline{1-3}
checkbox\+Circle\+Off   &\PBS\centering Ⓘ   &\PBS\centering ( )    \\\cline{1-3}
question\+Mark\+Prefix   &\PBS\centering ?⃝   &\PBS\centering ？    \\\cline{1-3}
one\+Half   &\PBS\centering ½   &\PBS\centering 1/2    \\\cline{1-3}
one\+Third   &\PBS\centering ⅓   &\PBS\centering 1/3    \\\cline{1-3}
one\+Quarter   &\PBS\centering ¼   &\PBS\centering 1/4    \\\cline{1-3}
one\+Fifth   &\PBS\centering ⅕   &\PBS\centering 1/5    \\\cline{1-3}
one\+Sixth   &\PBS\centering ⅙   &\PBS\centering 1/6    \\\cline{1-3}
one\+Seventh   &\PBS\centering ⅐   &\PBS\centering 1/7    \\\cline{1-3}
one\+Eighth   &\PBS\centering ⅛   &\PBS\centering 1/8    \\\cline{1-3}
one\+Ninth   &\PBS\centering ⅑   &\PBS\centering 1/9    \\\cline{1-3}
one\+Tenth   &\PBS\centering ⅒   &\PBS\centering 1/10    \\\cline{1-3}
two\+Thirds   &\PBS\centering ⅔   &\PBS\centering 2/3    \\\cline{1-3}
two\+Fifths   &\PBS\centering ⅖   &\PBS\centering 2/5    \\\cline{1-3}
three\+Quarters   &\PBS\centering ¾   &\PBS\centering 3/4    \\\cline{1-3}
three\+Fifths   &\PBS\centering ⅗   &\PBS\centering 3/5    \\\cline{1-3}
three\+Eighths   &\PBS\centering ⅜   &\PBS\centering 3/8    \\\cline{1-3}
four\+Fifths   &\PBS\centering ⅘   &\PBS\centering 4/5    \\\cline{1-3}
five\+Sixths   &\PBS\centering ⅚   &\PBS\centering 5/6    \\\cline{1-3}
five\+Eighths   &\PBS\centering ⅝   &\PBS\centering 5/8    \\\cline{1-3}
seven\+Eighths   &\PBS\centering ⅞   &\PBS\centering 7/8   \\\cline{1-3}
\end{longtabu}
\hypertarget{md_sfcode_node_modules_figures_readme_autotoc_md10401}{}\doxysection{Related}\label{md_sfcode_node_modules_figures_readme_autotoc_md10401}

\begin{DoxyItemize}
\item \href{https://github.com/sindresorhus/log-symbols}{\texttt{ log-\/symbols}} -\/ Colored symbols for various log levels
\end{DoxyItemize}

\DoxyHorRuler{0}


 {\bfseries{ \href{https://tidelift.com/subscription/pkg/npm-figures?utm_source=npm-figures&utm_medium=referral&utm_campaign=readme}{\texttt{ Get professional support for this package with a Tidelift subscription}} }} ~\newline
 \textsubscript{ Tidelift helps make open source sustainable for maintainers while giving companies~\newline
assurances about security, maintenance, and licensing for their dependencies. }  