Packages

erg_unicode

0.1.0
0.1.0

Erlang unicode utils functions library

HexDocs

Current section

Files

Jump to
Readme
1 Version
0 Dependencies
Dependants
Files
Activity
erg_unicode doc readme.html
Raw

doc/readme.html 

<!DOCTYPE html>

<html lang="en">

  <head>

    <meta charset="utf-8">

    <meta http-equiv="x-ua-compatible" content="ie=edge">

    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <meta name="generator" content="ExDoc v0.32.2">

    <meta name="project" content="erg_unicode v0.1.0">





    <title>Overview — erg_unicode v0.1.0</title>

    <link rel="stylesheet" href="dist/html-erlang-EBZIIHAS.css" />





    <script src="dist/handlebars.runtime-NWIB6V2M.js"></script>

    <script src="dist/handlebars.templates-K7URE6B4.js"></script>

    <script src="dist/sidebar_items-CB019701.js"></script>

    <script src="docs_config.js"></script>

    <script async src="dist/html-BHYOTRCH.js"></script>





  </head>

  <body data-type="extras" class="page-extra">

    <script>



      try {

        var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');



        if (settings.theme === 'dark' ||

           ((settings.theme === 'system' || settings.theme == null) &&

             window.matchMedia('(prefers-color-scheme: dark)').matches)

           ) {

          document.body.classList.add('dark')

        }

      } catch (error) { }

    </script>



<div class="body-wrapper">



<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">

  <i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>

</button>



<nav id="sidebar" class="sidebar">



  <div class="sidebar-header">

    <div class="sidebar-projectInfo">



      <div>

        <a href="https://github.com/ergenius/erg_unicode" class="sidebar-projectName" translate="no">

erg_unicode

        </a>

        <div class="sidebar-projectVersion" translate="no">

          v0.1.0

        </div>

      </div>

    </div>

    <ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">

      <li>

        <button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">

Pages

        </button>

      </li>



        <li>

          <button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">

            Modules

          </button>

        </li>





    </ul>

  </div>



  <div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">

    <ul id="extras-full-list" class="full-list"></ul>

  </div>



    <div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>

      <ul id="modules-full-list" class="full-list"></ul>

    </div>





</nav>



<main class="content">

  <output role="status" id="toast"></output>



  <div id="content" class="content-inner">

    <div class="top-search">

      <div class="search-settings">

        <form class="search-bar" action="search.html">

          <label class="search-label">

            <span class="sr-only">Search documentation of erg_unicode</span>

            <input name="q" type="text" class="search-input" placeholder="Press / to search" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />

          </label>

          <button type="submit" class="search-button" aria-label="Submit Search">

            <i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>

          </button>

          <button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">

            <i class="ri-close-line ri-lg" title="Cancel search"></i>

          </button>

        </form>

        <div class="autocomplete">

        </div>

        <button class="icon-settings display-settings">

          <i class="ri-settings-3-line"></i>

          <span class="sr-only">Settings</span>

        </button>

      </div>

    </div>



<div id="top-content">

  <h1>



      <a href="https://github.com/ergenius/erg_unicode/blob/v0.1.0/README.md#L1" title="View Source" class="icon-action" rel="help">

        <i class="ri-code-s-slash-line" aria-hidden="true"></i>

        <span class="sr-only">View Source</span>

      </a>





    <span>erg_unicode</span>

  </h1>



<p>Erlang Unicode Utils Library</p><p>erg_unicode is a library implemented some most wanted unicode functions that are missing from Erlang otp such as:</p><ul><li>unicode trim</li><li>unicode trim_left</li><li>unicode trim_right</li><li>unicode to_lower</li><li>unicode to_upper</li><li>unicode to_title</li><li>is_unicode_name</li><li>is_unicode_alpha</li><li>is_unicode_numeric</li><li>is_unicode_alpha_numeric</li><li>is_unicode_space</li><li>is_unicode_line_break</li><li>is_unicode_space_or_line_break</li></ul><p><a href="https://github.com/ergenius/erg_unicode/actions/workflows/erlang.yml"><img src="https://github.com/ergenius/erg_unicode/actions/workflows/erlang.yml/badge.svg" alt="Erlang CI"/></a></p><p>erg_unicode is also available on <a href="https://hex.pm/packages/erg_unicode/">HEX</a></p><h2 id="features" class="section-heading">

  <a href="#features" class="hover-link">

    <i class="ri-link-m" aria-hidden="true"></i>

  </a>

  <span class="text">Features</span>

</h2>

<ul><li>Fast.</li><li>Simple.</li></ul><h2 id="project-roadmap" class="section-heading">

  <a href="#project-roadmap" class="hover-link">

    <i class="ri-link-m" aria-hidden="true"></i>

  </a>

  <span class="text">Project roadmap</span>

</h2>

<ol><li>Continuously fixing bugs and tuning performance.</li><li>Writing testing units.</li><li>Add more features.</li></ol><h2 id="erlang-versions-supported" class="section-heading">

  <a href="#erlang-versions-supported" class="hover-link">

    <i class="ri-link-m" aria-hidden="true"></i>

  </a>

  <span class="text">Erlang versions supported</span>

</h2>

<p>This project officially supports OTP release 25 and later.</p><p>Development takes place using OTP 27 release and tests are done on:</p><ul><li>27.0.1</li><li>26.2.5</li><li>25.3.2</li></ul><p>Unofficially, you may be able to use this project with older Erlang versions. No guarantee included.</p><h2 id="dependencies" class="section-heading">

  <a href="#dependencies" class="hover-link">

    <i class="ri-link-m" aria-hidden="true"></i>

  </a>

  <span class="text">Dependencies</span>

</h2>

<p>None.</p><h2 id="authors" class="section-heading">

  <a href="#authors" class="hover-link">

    <i class="ri-link-m" aria-hidden="true"></i>

  </a>

  <span class="text">Authors</span>

</h2>

<ul><li>Madalin Grigore-Enescu (ergenius) - <a href="https://github.com/ergenius">Github</a> <a href="<https://ergenius.com>">ergenius.com</a></li></ul><h2 id="license" class="section-heading">

  <a href="#license" class="hover-link">

    <i class="ri-link-m" aria-hidden="true"></i>

  </a>

  <span class="text">License</span>

</h2>

<p>erg_unicode is available under the MIT license (see <code class="inline">LICENSE</code>).</p>

</div>



<div class="bottom-actions" id="bottom-actions">

  <div class="bottom-actions-item">



      <a href="api-reference.html" class="bottom-actions-button" rel="prev">

        <span class="subheader">

          ← Previous Page

        </span>

        <span class="title">

API Reference

        </span>

      </a>



  </div>

  <div class="bottom-actions-item">



      <a href="license.html" class="bottom-actions-button" rel="next">

        <span class="subheader">

          Next Page →

        </span>

        <span class="title">

License

        </span>

      </a>



  </div>

</div>

    <footer class="footer">

      <p>



          <span class="line">

            <a href="https://hex.pm/packages/erg_unicode/0.1.0" class="footer-hex-package">Hex Package</a>



            <a href="https://preview.hex.pm/preview/erg_unicode/0.1.0">Hex Preview</a>



              (<a href="https://preview.hex.pm/preview/erg_unicode/0.1.0/show/README.md">current file</a>)



          </span>



        <span class="line">

          <button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">

            Search HexDocs

          </button>



            <a href="erg_unicode.epub" title="ePub version">

              Download ePub version

            </a>



        </span>

      </p>



      <p class="built-using">

        Built using

        <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.32.2) for the



          <a href="https://erlang.org" title="Erlang" target="_blank" translate="no">Erlang programming language</a>



      </p>



    </footer>

  </div>

</main>

</div>





  </body>

</html>