Release v2.1.0

prjctimg · Mar 22, 2024 · 16431f1 · 16431f1
1 parent c6ad9f4
commit 16431f1
Show file tree

Hide file tree

Showing 23 changed files with 695 additions and 680 deletions.
diff --git a/docs/assets/gulpfile.js b/docs/assets/gulpfile.js
@@ -63,17 +63,17 @@ export async function xml() {
           path: ['./xml/'],
           manageEnv: ApiDocsEnv(srcFile, {
             previous: {
-              href: idx > 0 ? `/api/${moduleNames[--idx]}` : '/index.html',
-              title: idx > 0 ? moduleNames[--idx] : `Return to home page`
+              href: idx > 0 ? `/api/${moduleNames[idx - 1]}` : '/index.html',
+              title: idx > 0 ? moduleNames[idx - 1] : `Return to home page`
             },
             next: {
               href:
                 idx < moduleNames.length
-                  ? `/api/${moduleNames[++idx]}`
+                  ? `/api/${moduleNames[idx + 1]}`
                   : `/api`,
               title:
-                idx < moduleNames.length
-                  ? moduleNames[++idx]
+                idx <= moduleNames.length
+                  ? moduleNames[idx + 1]
                   : `Return to home page`
             }
           }),

diff --git a/docs/assets/js/docs.cjs b/docs/assets/js/docs.cjs
@@ -123,7 +123,6 @@ function generateDocs(source, cb = null) {
 // Loop through the markdown files for modules
 function buildDataObject(sourceModule, markupTransform = null) {
   var time = new Intl.DateTimeFormat('en-US', {
-    weekday: 'long',
     month: 'short',
     day: 'numeric',
 

diff --git a/docs/assets/pages/api.md b/docs/assets/pages/api.md
@@ -4,13 +4,13 @@ The library is split into individual modules each with functions that have the s
 
 ### Modules
 
-- [accessibility](api/accessibility)
-- [colors](api/colors)
-- [converters](api/converters)
-- [filterBy](api/filterBy)
-- [generators](api/generators)
-- [sortBy](api/sortBy)
-- [stats](api/stats)
-- [types](api/types)
-- [utils](api/utils)
-- [wrappers](api/wrappers)
+- [accessibility](accessibility)
+- [colors](colors)
+- [converters](converters)
+- [filterBy](filterBy)
+- [generators](generators)
+- [sortBy](sortBy)
+- [stats](stats)
+- [types](types)
+- [utils](utils)
+- [wrappers](wrappers)
diff --git a/docs/assets/tailwind.config.js b/docs/assets/tailwind.config.js
@@ -46,7 +46,6 @@ export default {
     backdropSepia: ({ theme }) => theme('sepia'),
     backgroundColor: ({ theme }) => theme('colors'),
     backgroundImage: {
-      'hero-home': 'url(assets/img/night-sky-over-mountains.jpg)',
       none: 'none',
       'gradient-to-t': 'linear-gradient(to top, var(--tw-gradient-stops))',
       'gradient-to-tr':

diff --git a/docs/assets/xml/layouts/base.njk b/docs/assets/xml/layouts/base.njk
@@ -2,7 +2,7 @@
 <html lang="en">
     {% include "partials/head.njk" %}
 
-    <body class="markdown-body container mx-auto font-sans bg-slate-100">
+    <body class="markdown-body md:container md:mx-auto font-sans bg-slate-100">
         {% include "partials/navbar.njk" %}
         {% block content %} {% endblock content %}
 

diff --git a/docs/assets/xml/partials/pagination.njk b/docs/assets/xml/partials/pagination.njk
@@ -1,12 +1,13 @@
 <section class="flex justify-between divide-x-[1px] divide-slate-400">
 
-    <a href="{{page.previous.href}}" class='flex align-middle space-x-2 p-4' id="previous-button"><svg
-            xmlns="http://www.w3.org/2000/svg" width="22" height="24" viewBox="0 0 24 24" fill="none"
-            stroke="currentColor" stroke-width="1.75" stroke-linecap="round" stroke-linejoin="round"
-            class="feather feather-chevron-left">
-            <polyline points="15 18 9 12 15 6"></polyline>
-        </svg><span></span>
-        <h5 class="font-sans text-sm text-slate-700 tracking-tight dark:text-slate-300">{{page.previous.title}}</h5>
+    <a href="{{page.previous.href}}" class='flex space-x-2 p-4' id="previous-button"><span><svg
+                xmlns="http://www.w3.org/2000/svg" width="22" height="24" viewBox="0 0 24 24" fill="none"
+                stroke="currentColor" stroke-width="1.75" stroke-linecap="round" stroke-linejoin="round"
+                class="feather feather-chevron-left">
+                <polyline points="15 18 9 12 15 6"></polyline>
+            </svg></span>
+        <h5 class="inline font-sans text-sm text-slate-700 tracking-tight dark:text-slate-300">{{page.previous.title}}
+        </h5>
     </a>
 
     <a href="{{page.next.href}}" class='flex space-x-2 p-4 items-center'><span><svg xmlns="http://www.w3.org/2000/svg"

diff --git a/docs/assets/xml/views/demo.njk b/docs/assets/xml/views/demo.njk
@@ -3,30 +3,31 @@
 
 {% block content %}
 {% for mod,prop in demoData %}
-<section class="flex-col p-4 bg-slate-100 my-4 rounded-md shadow-md">
+<section class="flex-col bg-slate-100 my-3 shadow-md">
 
     <h3 class="font-sans text-lg font-semibold text-slate-700">{{mod}}</h3>
 
     <p class="pb-6 font-sans text-slate-500 text-base font-normal">{{prop.description}}</p>
 
     {% for func,props in prop.specs %}
     <h4 class="font-sans text-slate-700 font-semibold text-base">{{func}}</h4>
-    <p class="pt-2 font-sans text-slate-500 text-sm ">{{props.description}}</p>
-    <p class="py-2 font-sans text-slate-500 text-sm ">Output:</p>
-    <div class="grid grid-cols-6  gap-4">
+    <p class="pt-3 font-sans text-slate-500 text-sm ">{{props.description}}</p>
+
+    <hr class="divide-y">
+
+    <div class="flex space-x-2 p-2 flex-wrap">
         {% if isColorCollection(props.expect) %}
         {% for color in props.expect %}
-        <div class="place-items-center">
+        <div class="flex-col space-y-2">
             <div class="w-8 h-8 rounded-md shadow-md bg-[{{color}}]"></div>
+            <p class="text-xs font-sans font-normal text-slate-400">{{color}}</p>
 
         </div>
         {% endfor %}
         {% else %}
-        <div class="place-items-center">
-
+        <div class="flex-col space-y-2">
+            <p class="text-sm">{{props.expect}}</p>
             <div class="w-8 h-8 rounded-md shadow-md bg-[{{props.expect}}]"></div>
-            <p class="text-xs font-sans font-normal text-slate-400">{{color}}</p>
-
         </div>
 
         {% endif %}

diff --git a/docs/assets/xml/views/post.njk b/docs/assets/xml/views/post.njk
@@ -4,58 +4,57 @@
 
 
 {% block content %}
-<div>
-    <article class='markdown-body font-sans'>
-        <div class="flex justify-start w-full space-x-2">
 
-            <div class='flex flex-row w-full justify-end'>
+<article class='markdown-body font-sans'>
+    <div class="flex justify-start w-full space-x-2">
 
+        <div class='flex flex-row w-full justify-end'>
 
-                <a class='grid-rows-2 place-items-start' href={{data.declFile}}>
-                    <button
-                        class="flex-col place-items-start py-1 bg-sky-500 border-none font-sans text-sm text-white">Edit
-                        this page</button>
-                    <span class="inline ml-1"><span> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="18"
-                                viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.75"
-                                stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit">
-                                <path d="M11 4H4a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2v-7"></path>
-                                <path d="M18.5 2.5a2.121 2.121 0 0 1 3 3L12 15l-4 1 1-4 9.5-9.5z"></path>
-                            </svg>
 
-                        </span>
-                </a>
+            <a class='grid-rows-2 place-items-start' href={{data.declFile}}>
+                <button class="flex-col place-items-start py-1 bg-sky-500 border-none font-sans text-sm text-white">Edit
+                    this page</button>
+                <span class="inline ml-1"><span> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="18"
+                            viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.75"
+                            stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit">
+                            <path d="M11 4H4a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2v-7"></path>
+                            <path d="M18.5 2.5a2.121 2.121 0 0 1 3 3L12 15l-4 1 1-4 9.5-9.5z"></path>
+                        </svg>
 
-                <div class='flex flex-col'><span class='font-normal font-sans text-sm text-slate-500'>last updated
-                        </span'>
-                        <p class='text-slate-600 text-xs font-sans font-semibold'>{{data.lastUpdated}}</p>
-                </div>
+                    </span>
+            </a>
 
+            <div class='flex flex-col'><span class='font-normal font-sans text-sm text-slate-500'>last updated
+                    </span'>
+                    <p class='text-slate-600 text-xs font-sans font-semibold'>{{data.lastUpdated}}</p>
             </div>
 
-
         </div>
 
 
+    </div>
 
 
-        <div class="flex flex-row space-x-2 pt-8 pb-1 mb-4 w-fit">
-            <a href="{{data.specFile}}" class="flex space-x-1 font-sans">
-                <span>Tests 🧪</span>
 
 
-            </a>
-            <a href="{{data.srcFile}}" class="flex space-x-1 font-sans">
-                <span>Source 🧾</span>
-            </a>
-        </div>
+    <div class="flex flex-row space-x-2 pt-8 pb-1 mb-4 w-fit">
+        <a href="{{data.specFile}}" class="flex space-x-1 font-sans">
+            <span>Tests 🧪</span>
+
+
+        </a>
+        <a href="{{data.srcFile}}" class="flex space-x-1 font-sans">
+            <span>Source 🧾</span>
+        </a>
+    </div>
 
-    </article>
+</article>
 
 
 
-    {{data.mainContent|safe}}
+{{data.mainContent|safe}}
 
-    </article>
+</article>
 
 </div>
 {% include "./partials/pagination.njk" %}

diff --git a/docs/www/api/accessibility/index.html b/docs/www/api/accessibility/index.html
@@ -14,10 +14,10 @@
 
 </head>
 
-    <body class="markdown-body">
-        <header class="pb-8 sticky top-0 left-0  w-full text-slate-700">
+    <body class="markdown-body md:container md:mx-auto font-sans bg-slate-100">
+        <header class="pb-8 font-sans sticky top-0 left-0  w-full text-slate-700">
     <nav
-        class="py-4 flex flex-wrap items-center justify-between w-full  px-4 text-lg text-slate-700 bg-slate-100 dark:text-slate-200 shadow-md shadow-gray-200 dark:shadow-black dark:bg-slate-800">
+        class="py-4 flex flex-wrap items-center justify-between w-full  px-4 text-lg text-slate-700 bg-slate-200 dark:text-slate-200 shadow-md shadow-gray-200 dark:shadow-black dark:bg-slate-800">
 
         <a class="inline-flex space-y-1 items-center font-medium text-base" href="https://huetiful-js.com"
             id="home"><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none"
@@ -60,56 +60,59 @@
         </a>
 
     </nav>
-    <div id='progress-bar' class='progress bg-gradient-to-r from-orange-600 via-purple-600 to-emerald-600' />
+    <div id='progress-bar'
+        class='progress dark:bg-gradient-to-r from-orange-400 via-purple-400 to-emerald-400  bg-gradient-to-r from-orange-600 via-purple-600 to-emerald-600' />
 </header>
 
-<div>
-    <article class='markdown-body'>
-        <div class="flex justify-start w-full space-x-2">
 
-            <div class='flex flex-row w-full justify-end'>
+<article class='markdown-body font-sans'>
+    <div class="flex justify-start w-full space-x-2">
 
+        <div class='flex flex-row w-full justify-end'>
 
-                <a class='flex w-fit items-center' href=https://github.com/xml-wizard/huetiful/blob/main/types/accessibility.d.ts><button
-                        class="pr-2 py-2 bg-sky-500 border-none text-sm text-white">Edit this page</button><span
-                        class="inline ml-1"><span> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="18"
-                                viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.75"
-                                stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit">
-                                <path d="M11 4H4a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2v-7"></path>
-                                <path d="M18.5 2.5a2.121 2.121 0 0 1 3 3L12 15l-4 1 1-4 9.5-9.5z"></path>
-                            </svg>
 
-                        </span>
-                </a>
+            <a class='grid-rows-2 place-items-start' href=https://github.com/xml-wizard/huetiful/blob/main/types/accessibility.d.ts>
+                <button class="flex-col place-items-start py-1 bg-sky-500 border-none font-sans text-sm text-white">Edit
+                    this page</button>
+                <span class="inline ml-1"><span> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="18"
+                            viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.75"
+                            stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit">
+                            <path d="M11 4H4a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2v-7"></path>
+                            <path d="M18.5 2.5a2.121 2.121 0 0 1 3 3L12 15l-4 1 1-4 9.5-9.5z"></path>
+                        </svg>
 
-                <div class='flex flex-col'><span class='font-normal text-sm text-slate-500'>last updated</span'>
-                        <p class='text-slate-600 text-xs font-sans font-semibold'>Tuesday, Mar 19, in the afternoon</p>
-                </div>
+                    </span>
+            </a>
 
+            <div class='flex flex-col'><span class='font-normal font-sans text-sm text-slate-500'>last updated
+                    </span'>
+                    <p class='text-slate-600 text-xs font-sans font-semibold'>Mar 19, in the afternoon</p>
             </div>
 
-
         </div>
 
 
+    </div>
 
 
-        <div class="flex flex-row space-x-2 pt-8 pb-1 mb-4 w-fit">
-            <a href="https://github.com/xml-wizard/huetiful/blob/main/spec/accessibility.spec.js" class="flex space-x-1">
-                <span>Tests 🧪</span>
 
 
-            </a>
-            <a href="https://github.com/xml-wizard/huetiful/blob/main/src/accessibility.js" class="flex space-x-1">
-                <span>Source 🧾</span>
-            </a>
-        </div>
+    <div class="flex flex-row space-x-2 pt-8 pb-1 mb-4 w-fit">
+        <a href="https://github.com/xml-wizard/huetiful/blob/main/spec/accessibility.spec.js" class="flex space-x-1 font-sans">
+            <span>Tests 🧪</span>
 
-    </article>
 
+        </a>
+        <a href="https://github.com/xml-wizard/huetiful/blob/main/src/accessibility.js" class="flex space-x-1 font-sans">
+            <span>Source 🧾</span>
+        </a>
+    </div>
+
+</article>
 
 
-    <h1 id="module-📦-accessibility">Module 📦: accessibility</h1>
+
+<h1 id="module-📦-accessibility">Module 📦: accessibility</h1>
 <h2 id="table-of-contents-📑">Table of contents 📑</h2>
 <h3 id="functions-🧰">Functions 🧰</h3>
 <ul>
@@ -178,26 +181,27 @@ <h5 id="returns-🔙-1">Returns 🔙</h5>
 <h4 id="defined-in-📝">Defined in 📝</h4>
 <p><a href="https://github.com/prjctimg/huetiful/blob/12f39ea/types/accessibility.d.ts#L25">accessibility.d.ts:25</a></p>
 
-    </article>
+</article>
 
 </div>
 <section class="flex justify-between divide-x-[1px] divide-slate-400">
 
-    <a href="/index.html" class='flex align-middle space-x-2 p-4' id="previous-button"><svg
-            xmlns="http://www.w3.org/2000/svg" width="22" height="24" viewBox="0 0 24 24" fill="none"
-            stroke="currentColor" stroke-width="1.75" stroke-linecap="round" stroke-linejoin="round"
-            class="feather feather-chevron-left">
-            <polyline points="15 18 9 12 15 6"></polyline>
-        </svg><span></span>
-        <h5 class="font-sans text-sm text-slate-700 tracking-tight dark:text-slate-300">Return to home page</h5>
+    <a href="/index.html" class='flex space-x-2 p-4' id="previous-button"><span><svg
+                xmlns="http://www.w3.org/2000/svg" width="22" height="24" viewBox="0 0 24 24" fill="none"
+                stroke="currentColor" stroke-width="1.75" stroke-linecap="round" stroke-linejoin="round"
+                class="feather feather-chevron-left">
+                <polyline points="15 18 9 12 15 6"></polyline>
+            </svg></span>
+        <h5 class="inline font-sans text-sm text-slate-700 tracking-tight dark:text-slate-300">Return to home page
+        </h5>
     </a>
 
     <a href="/api/colors" class='flex space-x-2 p-4 items-center'><span><svg xmlns="http://www.w3.org/2000/svg"
                 width="22" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.75"
                 stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right">
                 <polyline points="9 18 15 12 9 6"></polyline>
             </svg></span>
-        <h5 class="font-sans text-sm text-slate-700 tracking-tight dark:text-slate-300">converters</h5>
+        <h5 class="font-sans text-sm text-slate-700 tracking-tight dark:text-slate-300">colors</h5>
     </a>
 
 
@@ -258,7 +262,7 @@ <h5 class="font-sans text-sm text-slate-700 tracking-tight dark:text-slate-300">
 
 
             <div class="pt-2">
-                <blockquote class="inline-block text-sm">
+                <blockquote class="inline-block text-sm font-sans text-white">
                     <p class="text-sm">
                         <span class="inline-block"><svg xmlns="http://www.w3.org/2000/svg" width="12" height="14"
                                 viewBox="0 0 24 24" fill="none" stroke="white" stroke-width="1.75"