Skip to content

Commit

Permalink
init docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mzusin
mzusin committed Jul 12, 2023
1 parent ec00fdd commit ad46e60
Show file tree
Hide file tree
Showing 38 changed files with 5,524 additions and 112 deletions.
10 changes: 10 additions & 0 deletions docs/css/styles.1689160589794.css
View file

Large diffs are not rendered by default.

94 changes: 94 additions & 0 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>React Round Slider</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1" />

<!-- google fonts -->
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&display=swap" rel="stylesheet">

<!-- favicon -->
<link rel="apple-touch-icon" sizes="180x180" href="/img/favicon/apple-touch-icon.png" />
<link id="favicon-48" rel="icon" type="image/png" sizes="48x48" href="/img/favicon/favicon-48.png" />
<link id="favicon-32" rel="icon" type="image/png" sizes="32x32" href="/img/favicon/favicon-32.png" />
<link id="favicon-16" rel="icon" type="image/png" sizes="16x16" href="/img/favicon/favicon-16.png" />

<link rel="stylesheet" href="/css/styles.1689160589794.css" />
<!--<link rel="stylesheet" href="/js/index.1689160589794.css" />-->

</head>
<body class="font-roboto bg-gray-900 text-gray-100" id="special-page">
<div class="flex justify-center items-center bg-purple-800 border-b border-purple-700">
<p class="text-center p-2 text-sm">
🤩 If you like this project, please support us by starring our <a target="_blank" rel="noopener noreferrer" href="https://github.com/mzusin/react-round-slider" class="underline">GitHub repository</a> 🤩</p>
</div>

<header class="py-4 px-10 shadow-md flex items-center justify-between bg-gray-800">
<div class="flex items-center">
<a href="/" title="" class="inline-flex items-center">
<svg
xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"
stroke-width="3.48" stroke="rgba(255, 255, 255, 1)"
class="mr-4"
fill="none" stroke-linecap="round" stroke-linejoin="round">
<circle cx="50%" cy="50%" r="50%" stroke="none" stroke-width="0" fill="rgba(40, 95, 104, 1)"/>
<g transform="translate(3.36, 3.36) scale(0.72)">
<g transform="rotate(25.2 12 12)">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<path d="M6 20v-16l6 14l6 -14v16"/>
</g>
</g>
</svg>

React Round Slider
</a>
</div>

<div class="flex items-center">
<a href="/pages/basic-usage.html" title="" class="mx-2 inline-block">Documentation</a>
<!--<a href="/pages/plugins.html" title="" class="mx-2 hidden md:inline-block">Plugins</a>-->

<a href="https://github.com/mzusin/react-round-slider" class="border-l border-l-gray-600 pl-4 mx-2 inline-block text-slate-400 hover:text-slate-500"><span class="sr-only">React Round Slider on GitHub</span><svg viewBox="0 0 16 16" class="w-5 h-5" fill="currentColor" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path></svg></a>

</div>
</header>

<div id="hp-main">
<div class="relative max-w-5xl mx-auto pt-20 sm:pt-24 lg:pt-32 mb-20">
<h1 class="text-slate-100 font-extrabold text-4xl sm:text-5xl lg:text-6xl tracking-tight text-center px-4">React Round Slider</h1>

<p class="mt-12 sm:text-2xl lg:text-3x text-slate-400 text-center max-w-3xl mx-auto px-4 pb-6">SVG and TypeScript React round slider library.</p>

<div class="mt-12 sm:mt-10 flex justify-center space-x-6 text-sm">
<a class="get-started-btn bg-slate-100 hover:bg-slate-200 focus:outline-none focus:ring-2 focus:ring-slate-200 focus:ring-offset-2 focus:ring-offset-slate-50 text-gray-900 font-semibold px-14 py-5 text-lg rounded-lg flex items-center justify-center sm:w-auto" href="/pages/basic-usage.html">
Get Started &rarr;
</a>
</div>
</div>
</div>


<!--<footer class="px-4 py-4 py-6">
<div class="flex flex-wrap items-center justify-center text-center px-4 py-3">
<span class="flex items-center justify-center mx-4 my-2">
<a class="ml-2 underline" href="/">React Round Slider</a>
</span>
<span class="flex items-center justify-center mx-4 my-2">© All rights reserved.</span>
<a href="mailto:miriam.zusin@gmail.com" title="" class="mx-4 my-2 flex items-center">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" width="20" height="20">
<path fill="#111" d="M502.3 190.8c3.9-3.1 9.7-.2 9.7 4.7V400c0 26.5-21.5 48-48 48H48c-26.5 0-48-21.5-48-48V195.6c0-5 5.7-7.8 9.7-4.7 22.4 17.4 52.1 39.5 154.1 113.6 21.1 15.4 56.7 47.8 92.2 47.6 35.7.3 72-32.8 92.3-47.6 102-74.1 131.6-96.3 154-113.7zM256 320c23.2.4 56.6-29.2 73.4-41.4 132.7-96.3 142.8-104.7 173.4-128.7 5.8-4.5 9.2-11.5 9.2-18.9v-19c0-26.5-21.5-48-48-48H48C21.5 64 0 85.5 0 112v19c0 7.4 3.4 14.3 9.2 18.9 30.6 23.9 40.7 32.4 173.4 128.7 16.8 12.2 50.2 41.8 73.4 41.4z"></path>
</svg> <span class="ml-2 underline">Contact Us</span>
</a>
</div>
</footer>-->

<script src="/js/index.1689160589794.js"></script>
</body>
</html>
10 changes: 10 additions & 0 deletions docs/js/index.1689160589794.js
View file

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions docs/js/index.1689160589794.js.map
View file

Large diffs are not rendered by default.

192 changes: 192 additions & 0 deletions docs/pages/basic-usage.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>React Round Slider Documentation</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1" />

<!-- google fonts -->
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&display=swap" rel="stylesheet">

<!-- favicon -->
<link rel="apple-touch-icon" sizes="180x180" href="/img/favicon/apple-touch-icon.png" />
<link id="favicon-48" rel="icon" type="image/png" sizes="48x48" href="/img/favicon/favicon-48.png" />
<link id="favicon-32" rel="icon" type="image/png" sizes="32x32" href="/img/favicon/favicon-32.png" />
<link id="favicon-16" rel="icon" type="image/png" sizes="16x16" href="/img/favicon/favicon-16.png" />

<link rel="stylesheet" href="/css/styles.1689160589794.css" />
<!--<link rel="stylesheet" href="/js/index.1689160589794.css" />-->

</head>
<body class="h-screen flex flex-col font-roboto bg-white dark:bg-slate-900 dark:text-slate-100">

<header class="py-4 px-4 border-b shadow-sm bg-slate-100 dark:bg-slate-900 dark:text-slate-400 dark:border-black">
<div class="container mx-auto flex items-center justify-between">
<div class="flex items-center">
<!-- mobile menu button -->
<button
id="mobile-menu-btn"
type="button"
class="mr-4 pointer md:hidden">
<svg
xmlns="http://www.w3.org/2000/svg"
width="24"
height="24"
fill="none"
stroke="currentColor"
stroke-linecap="round"
stroke-linejoin="round"
stroke-width="1.5"
viewBox="0 0 24 24">
<path stroke="none" d="M0 0h24v24H0z"/>
<path d="M4 6h16M4 12h16M4 18h16"/>
</svg>
</button>

<a href="/" title="" class="flex items-center ml-6">
<svg
xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"
stroke-width="3.48" stroke="rgba(255, 255, 255, 1)"
class="mr-4"
fill="none" stroke-linecap="round" stroke-linejoin="round">
<circle cx="50%" cy="50%" r="50%" stroke="none" stroke-width="0" fill="rgba(40, 95, 104, 1)"/>
<g transform="translate(3.36, 3.36) scale(0.72)">
<g transform="rotate(25.2 12 12)">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<path d="M6 20v-16l6 14l6 -14v16"/>
</g>
</g>
</svg>
<span class="text-slate-600 dark:text-slate-400"><b>React Round Slider</b> Documentation</span>
</a>
</div>

<div class="flex items-center">

<!-- themes -->
<button type="button" id="move-to-dark-mode-btn" class="hidden">
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="mx-3 block" viewBox="0 0 24 24">
<path stroke="none" d="M0 0h24v24H0z"/>
<path d="M14.828 14.828a4 4 0 1 0-5.656-5.656 4 4 0 0 0 5.656 5.656zm-8.485 2.829-1.414 1.414M6.343 6.343 4.929 4.929m12.728 1.414 1.414-1.414m-1.414 12.728 1.414 1.414M4 12H2m10-8V2m8 10h2m-10 8v2"/>
</svg>
</button>

<button type="button" id="move-to-light-mode-btn" class="hidden">
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="mx-3 block" viewBox="0 0 24 24">
<path stroke="none" d="M0 0h24v24H0z"/>
<path fill="currentColor" stroke="none" d="M12 1.992a10 10 0 1 0 9.236 13.838c.341-.82-.476-1.644-1.298-1.31a6.5 6.5 0 0 1-6.864-10.787l.077-.08c.551-.63.113-1.653-.758-1.653h-.266l-.068-.006-.06-.002z"/>
</svg>
</button>

<a href="https://github.com/mzusin/react-round-slider" class="mx-3 block text-slate-400 hover:text-slate-500"><span class="sr-only">React Round Slider on GitHub</span><svg viewBox="0 0 16 16" class="w-5 h-5" fill="currentColor" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path></svg></a>

</div>
</div>
</header>

<div class="container mx-auto flex-1 overflow-hidden">
<div class="flex h-full">

<div class="side-menu border-r dark:border-slate-900 shadow-md overflow-y-auto h-full max-w-full min-w-270 md:w-350 absolute md:static md:left-auto bg-white dark:bg-slate-900 z-50" id="side-menu">
<div class="px-6 pb-4 flex flex-col relative">

<!-- mobile menu close -->
<button type="button" class="pointer absolute right-4 top-2 md:hidden" id="mobile-menu-close-btn">
<svg
xmlns="http://www.w3.org/2000/svg"
width="24"
height="24"
fill="none"
stroke="currentColor"
stroke-linecap="round"
stroke-linejoin="round"
stroke-width="1.5"
viewBox="0 0 24 24">
<path stroke="none" d="M0 0h24v24H0z"/>
<path d="M18 6 6 18M6 6l12 12"/>
</svg>
</button>

<div class="text-xl my-4 flex items-center cursor-pointer" data-collapsible-title data-opened="true" data-id="1-main">
Getting Started
<svg data-arrow xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" stroke="#626e7f" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="ml-2 rotate-90" viewBox="0 0 24 24">
<path stroke="none" d="M0 0h24v24H0z"/>
<path d="m7 7 5 5-5 5m6-10 5 5-5 5"/>
</svg>

</div><div class="flex flex-col" data-links><a href="/pages/basic-usage.html" title="" class="pl-3 border-l border-slate-150 dark:border-slate-600 pb-2 text-sky-500">Basic Usage</a><a href="/pages/nodejs.html" title="" class="pl-3 border-l border-slate-150 dark:border-slate-600 text-slate-500">Nodejs</a></div><div class="text-xl my-4 flex items-center cursor-pointer" data-collapsible-title data-opened="true" data-id="2-another">
Another
<svg data-arrow xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" stroke="#626e7f" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" class="ml-2 rotate-90" viewBox="0 0 24 24">
<path stroke="none" d="M0 0h24v24H0z"/>
<path d="m7 7 5 5-5 5m6-10 5 5-5 5"/>
</svg>

</div><div class="flex flex-col" data-links><a href="/pages/width-height-and-border-radius.html" title="" class="pl-3 border-l border-slate-150 dark:border-slate-600 pb-2 text-slate-500">Width Height And Border Radius</a><a href="/pages/colors.html" title="" class="pl-3 border-l border-slate-150 dark:border-slate-600 text-slate-500">Colors</a></div>
</div>
</div>

<div class="p-4 overflow-y-auto h-full md:w-100-350 dark:bg-slate-800">
<div class="w-800 max-w-full mx-auto my-10 leading-7 text-lg text-slate-800 dark:text-slate-200"><h2 class="text-3xl mb-8">Basic Usage</h2>
<p class="mb-4">Download the latest <a href="https://github.com/toolcool-org/toolcool-range-slider/blob/main/dist/toolcool-range-slider.min.js" class="text-sky-500">toolcool-range-slider.min.js</a> script from GitHub and add the following HTML to the page:</p>
<pre class="hljs p-4 mb-4 rounded-md shadow-xl overflow-auto whitespace-pre-wrap text-base"><code><span class="hljs-tag">&lt;<span class="hljs-name">tc-range-slider</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">tc-range-slider</span>&gt;</span>

<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;toolcool-range-slider.min.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
<div class="my-12 flex justify-center">
<tc-range-slider></tc-range-slider>
</div>
<p class="mb-4"><strong class="font-bold">tc-range-slider</strong> is an alias for <strong class="font-bold">toolcool-range-slider</strong>:</p>
<pre class="hljs p-4 mb-4 rounded-md shadow-xl overflow-auto whitespace-pre-wrap text-base"><code><span class="hljs-tag">&lt;<span class="hljs-name">toolcool-range-slider</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">toolcool-range-slider</span>&gt;</span>

<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;toolcool-range-slider.min.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
<p class="mb-4">The library is also available on the <a href="https://www.jsdelivr.com/package/npm/toolcool-range-slider" class="text-sky-500">jsDelivr CND</a>:</p>
<pre class="hljs p-4 mb-4 rounded-md shadow-xl overflow-auto whitespace-pre-wrap text-base"><code><span class="hljs-tag">&lt;<span class="hljs-name">tc-range-slider</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">tc-range-slider</span>&gt;</span>

<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;https://cdn.jsdelivr.net/npm/toolcool-range-slider/dist/toolcool-range-slider.min.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
<p class="mb-4">The initial value is defined using the <strong class="font-bold">value</strong> attribute:</p>
<pre class="hljs p-4 mb-4 rounded-md shadow-xl overflow-auto whitespace-pre-wrap text-base"><code><span class="hljs-tag">&lt;<span class="hljs-name">tc-range-slider</span> <span class="hljs-attr">value</span>=<span class="hljs-string">&quot;50&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">tc-range-slider</span>&gt;</span>

<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;toolcool-range-slider.min.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
<div class="my-12 flex justify-center">
<tc-range-slider value="50"></tc-range-slider>
</div>
<p class="mb-4">You can add more pointers using the <strong class="font-bold">value2</strong>, <strong class="font-bold">value3</strong>, and so on attributes. Note that <strong class="font-bold">value</strong>, <strong class="font-bold">value0</strong>, and <strong class="font-bold">value1</strong> are synonymous and refer to the first value.</p>
<pre class="hljs p-4 mb-4 rounded-md shadow-xl overflow-auto whitespace-pre-wrap text-base"><code><span class="hljs-tag">&lt;<span class="hljs-name">tc-range-slider</span> <span class="hljs-attr">value1</span>=<span class="hljs-string">&quot;20&quot;</span> <span class="hljs-attr">value2</span>=<span class="hljs-string">&quot;30&quot;</span> <span class="hljs-attr">value3</span>=<span class="hljs-string">&quot;40&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">tc-range-slider</span>&gt;</span>

<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;toolcool-range-slider.min.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
<div class="my-12 flex justify-center">
<tc-range-slider value1="20" value2="50" value3="80"></tc-range-slider>
</div>
</div>

<div class="w-800 max-w-full mx-auto grid gap-8 items-center text-slate-500">
<div class="flex justify-between items-start border border-slate-200 rounded p-4">

<div class="flex flex-col justify-center">
<div class="mb-2 text-sm text-slate-300">Next</div>
<a href="/pages/nodejs.html" title="" class="hover:text-blue-500">Nodejs</a>
</div>

<a href="/pages/nodejs.html" title="" class="mr-4 hover:text-blue-500">
<svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="1.5" viewBox="0 0 24 24">
<path stroke="none" d="M0 0h24v24H0z"/>
<path d="M5 12h14m-6 6 6-6m-6-6 6 6"/>
</svg>
</a>
</div>
</div>
</div>

</div>
</div>

<!--<footer class="py-2 px-4 border-t">
<div class="container mx-auto">
Footer
</div>
</footer>-->

<script src="/js/index.1689160589794.js"></script>
</body>
</html>
Loading

0 comments on commit ad46e60

Please sign in to comment.