diff options
Diffstat (limited to 'doc/modules/colorizer.color.html')
-rw-r--r-- | doc/modules/colorizer.color.html | 187 |
1 files changed, 6 insertions, 181 deletions
diff --git a/doc/modules/colorizer.color.html b/doc/modules/colorizer.color.html index 5947611..37a92cd 100644 --- a/doc/modules/colorizer.color.html +++ b/doc/modules/colorizer.color.html @@ -42,6 +42,11 @@ <li><a href="../modules/colorizer.buffer.html">buffer</a></li> <li><strong>color</strong></li> <li><a href="../modules/colorizer.matcher.html">matcher</a></li> + <li><a href="../modules/colorizer.parser.argb_hex.html">parser.argb_hex</a></li> + <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li> + <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li> + <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li> + <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</a></li> <li><a href="../modules/colorizer.sass.html">sass</a></li> <li><a href="../modules/colorizer.tailwind.html">tailwind</a></li> <li><a href="../modules/colorizer.trie.html">trie</a></li> @@ -53,7 +58,7 @@ <div id="content"> <h1>Module <code>colorizer.color</code></h1> -<p>Helper functions to parse different colour formats</p> +<p>Helper color functions</p> <p> </p> @@ -62,18 +67,10 @@ <h2><a href="#Functions">Functions</a></h2> <table class="function_list"> <tr> - <td class="name" nowrap><a href="#argb_hex_parser">argb_hex_parser (line, i)</a></td> - <td class="summary">parse for 0xaarrggbb and return rgb hex.</td> - </tr> - <tr> <td class="name" nowrap><a href="#hsl_to_rgb">hsl_to_rgb (h, s, l)</a></td> <td class="summary">Converts an HSL color value to RGB.</td> </tr> <tr> - <td class="name" nowrap><a href="#hsl_function_parser">hsl_function_parser (line, i, opts)</a></td> - <td class="summary">Parse for hsl() hsla() css function and return rgb hex.</td> - </tr> - <tr> <td class="name" nowrap><a href="#hue_to_rgb">hue_to_rgb (p, q, t)</a></td> <td class="summary">Convert hsl colour values to rgb.</td> </tr> @@ -81,18 +78,6 @@ <td class="name" nowrap><a href="#is_bright">is_bright (r, g, b)</a></td> <td class="summary">Determine whether to use black or white text.</td> </tr> - <tr> - <td class="name" nowrap><a href="#name_parser">name_parser (line, i, opts)</a></td> - <td class="summary">Grab all the colour values from <code>vim.api.nvim_get_color_map</code> and create a lookup table.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#rgb_function_parser">rgb_function_parser (line, i, opts)</a></td> - <td class="summary">Parse for rgb() rgba() css function and return rgb hex.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#rgba_hex_parser">rgba_hex_parser (line, i, opts)</a></td> - <td class="summary">parse for #rrggbbaa and return rgb hex.</td> - </tr> </table> <br/> @@ -103,37 +88,6 @@ <dl class="function"> <dt> - <a name = "argb_hex_parser"></a> - <strong>argb_hex_parser (line, i)</strong> - </dt> - <dd> - parse for 0xaarrggbb and return rgb hex. - a format used in android apps - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">line</span> - string: line to parse - </li> - <li><span class="parameter">i</span> - number: index of line from where to start parsing - </li> - </ul> - - <h3>Returns:</h3> - <ol> - <li> - number|nil: index of line where the hex value ended</li> - <li> - string|nil: rgb hex value</li> - </ol> - - - - -</dd> - <dt> <a name = "hsl_to_rgb"></a> <strong>hsl_to_rgb (h, s, l)</strong> </dt> @@ -165,40 +119,6 @@ </dd> <dt> - <a name = "hsl_function_parser"></a> - <strong>hsl_function_parser (line, i, opts)</strong> - </dt> - <dd> - Parse for hsl() hsla() css function and return rgb hex. - For more info: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">line</span> - string: Line to parse - </li> - <li><span class="parameter">i</span> - number: Index of line from where to start parsing - </li> - <li><span class="parameter">opts</span> - table: Values passed from matchers like prefix - </li> - </ul> - - <h3>Returns:</h3> - <ol> - <li> - number|nil: Index of line where the hsla/hsl function ended</li> - <li> - string|nil: rgb hex value</li> - </ol> - - - - -</dd> - <dt> <a name = "hue_to_rgb"></a> <strong>hue_to_rgb (p, q, t)</strong> </dt> @@ -259,101 +179,6 @@ </dd> - <dt> - <a name = "name_parser"></a> - <strong>name_parser (line, i, opts)</strong> - </dt> - <dd> - Grab all the colour values from <code>vim.api.nvim_get_color_map</code> and create a lookup table. - COLOR_MAP is used to store the colour values - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">line</span> - string: Line to parse - </li> - <li><span class="parameter">i</span> - number: Index of line from where to start parsing - </li> - <li><span class="parameter">opts</span> - table: Currently contains whether tailwind is enabled or not - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "rgb_function_parser"></a> - <strong>rgb_function_parser (line, i, opts)</strong> - </dt> - <dd> - Parse for rgb() rgba() css function and return rgb hex. - For more info: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">line</span> - string: Line to parse - </li> - <li><span class="parameter">i</span> - number: Index of line from where to start parsing - </li> - <li><span class="parameter">opts</span> - table: Values passed from matchers like prefix - </li> - </ul> - - <h3>Returns:</h3> - <ol> - <li> - number|nil: Index of line where the rgb/rgba function ended</li> - <li> - string|nil: rgb hex value</li> - </ol> - - - - -</dd> - <dt> - <a name = "rgba_hex_parser"></a> - <strong>rgba_hex_parser (line, i, opts)</strong> - </dt> - <dd> - parse for #rrggbbaa and return rgb hex. - a format used in android apps - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">line</span> - string: line to parse - </li> - <li><span class="parameter">i</span> - number: index of line from where to start parsing - </li> - <li><span class="parameter">opts</span> - table: Containing minlen, maxlen, valid_lengths - </li> - </ul> - - <h3>Returns:</h3> - <ol> - <li> - number|nil: index of line where the hex value ended</li> - <li> - string|nil: rgb hex value</li> - </ol> - - - - -</dd> </dl> |