diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/colorizer.txt | 62 | ||||
| -rw-r--r-- | doc/modules/colorizer.color.html | 49 | ||||
| -rw-r--r-- | doc/modules/colorizer.html | 5 | ||||
| -rw-r--r-- | doc/modules/colorizer.utils.html | 63 |
4 files changed, 72 insertions, 107 deletions
diff --git a/doc/colorizer.txt b/doc/colorizer.txt index 0dfbf63..a7d21b5 100644 --- a/doc/colorizer.txt +++ b/doc/colorizer.txt @@ -245,6 +245,8 @@ user_default_options *colorizer.user_default_options* -- parsers can contain values used in |user_default_options| sass = { enable = false, parsers = { css }, }, -- Enable sass colors virtualtext = "■", + -- update color values even if buffer is not focused + always_update = false } < @@ -263,6 +265,7 @@ user_default_options *colorizer.user_default_options* {tailwind} - boolean|string {sass} - table {virtualtext} - string + {always_update} - boolean @@ -430,9 +433,8 @@ Functions: ~ |name_parser| - Grab all the colour values from `vim.api.nvim_get_color_map` and create a lookup table. - |rgb_function_parser| - Parse for rgb() css function and return rgb hex. - - |rgba_function_parser| - Parse for rgba() css function and return rgb hex. + |rgb_function_parser| - Parse for rgb() rgba() css function and return rgb + hex. |rgba_hex_parser| - parse for #rrggbbaa and return rgb hex. @@ -529,33 +531,20 @@ name_parser({line}, {i}, {opts}) *colorizer.color.name_parser* -rgb_function_parser({line}, {i}) *colorizer.color.rgb_function_parser* - Parse for rgb() css function and return rgb hex. - - Parameters: ~ - {line} - string: Line to parse - {i} - number: Index of line from where to start parsing - - returns:~ - number or nil: Index of line where the rgb function ended - string or nil: rgb hex value - - - -rgba_function_parser({line}, {i}) *colorizer.color.rgba_function_parser* - Parse for rgba() css function and return rgb hex. +rgb_function_parser({line}, {i}, {opts}) *colorizer.color.rgb_function_parser* + Parse for rgb() rgba() css function and return rgb hex. - Todo consider removing the regexes here - Todo this might not be the best approach to alpha channel. - Things like pumblend might be useful here. + For more info: + https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb Parameters: ~ {line} - string: Line to parse {i} - number: Index of line from where to start parsing + {opts} - table: Values passed from matchers like prefix returns:~ - number or nil: Index of line where the rgba function ended + number or nil: Index of line where the rgb/rgba function ended string or nil: rgb hex value @@ -747,14 +736,14 @@ Functions: ~ |byte_is_valid_colorchar| - Valid colorchars are alphanumeric and - ( tailwind colors ) + |count| - Count the number of character in a string + |get_last_modified| - Get last modified time of a file |merge| - Merge two tables. |parse_hex| - Obvious. - |percent_or_hex| - Obvious. - |watch_file| - Watch a file for changes and execute callback @@ -791,6 +780,18 @@ byte_is_valid_colorchar({byte}) *colorizer.utils.byte_is_valid_colorchar* +count({str}, {pattern}) *colorizer.utils.count* + Count the number of character in a string + + Parameters: ~ + {str} - string + {pattern} - string + + returns:~ + number + + + get_last_modified({path}) *colorizer.utils.get_last_modified* Get last modified time of a file @@ -828,24 +829,13 @@ parse_hex({byte}) *colorizer.utils.parse_hex* -percent_or_hex({v}) *colorizer.utils.percent_or_hex* - Obvious. - - Parameters: ~ - {v} - string - - returns:~ - number or nil - - - watch_file({path}, {callback}, {...}) *colorizer.utils.watch_file* Watch a file for changes and execute callback Parameters: ~ {path} - string: File path {callback} - function: Callback to execute - {...} - array: params for callback + {...} - table: params for callback returns:~ function or nil diff --git a/doc/modules/colorizer.color.html b/doc/modules/colorizer.color.html index 751214c..5947611 100644 --- a/doc/modules/colorizer.color.html +++ b/doc/modules/colorizer.color.html @@ -86,12 +86,8 @@ <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)</a></td> - <td class="summary">Parse for rgb() css function and return rgb hex.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#rgba_function_parser">rgba_function_parser (line, i)</a></td> - <td class="summary">Parse for rgba() css function and return rgb hex.</td> + <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> @@ -292,10 +288,11 @@ </dd> <dt> <a name = "rgb_function_parser"></a> - <strong>rgb_function_parser (line, i)</strong> + <strong>rgb_function_parser (line, i, opts)</strong> </dt> <dd> - Parse for rgb() css function and return rgb hex. + 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> @@ -306,45 +303,15 @@ <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 rgb function ended</li> - <li> - string|nil: rgb hex value</li> - </ol> - - - - -</dd> - <dt> - <a name = "rgba_function_parser"></a> - <strong>rgba_function_parser (line, i)</strong> - </dt> - <dd> - Parse for rgba() css function and return rgb hex. - Todo consider removing the regexes here - Todo this might not be the best approach to alpha channel. - Things like pumblend might be useful here. - - - <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><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 rgba function ended</li> + number|nil: Index of line where the rgb/rgba function ended</li> <li> string|nil: rgb hex value</li> </ol> diff --git a/doc/modules/colorizer.html b/doc/modules/colorizer.html index 1196e4d..1d338e1 100644 --- a/doc/modules/colorizer.html +++ b/doc/modules/colorizer.html @@ -437,6 +437,8 @@ In <a href="../modules/colorizer.html#user_default_options">user_default_options -- parsers can contain values used in |user_default_options| sass = { enable = false, parsers = { css }, }, -- Enable sass colors virtualtext = "■", + -- update color values even if buffer is not focused + always_update = false } </pre> @@ -484,6 +486,9 @@ In <a href="../modules/colorizer.html#user_default_options">user_default_options <li><span class="parameter">virtualtext</span> string </li> + <li><span class="parameter">always_update</span> + boolean + </li> </ul> diff --git a/doc/modules/colorizer.utils.html b/doc/modules/colorizer.utils.html index d6a0216..5ebd197 100644 --- a/doc/modules/colorizer.utils.html +++ b/doc/modules/colorizer.utils.html @@ -74,6 +74,10 @@ <td class="summary">Valid colorchars are alphanumeric and - ( tailwind colors )</td> </tr> <tr> + <td class="name" nowrap><a href="#count">count (str, pattern)</a></td> + <td class="summary">Count the number of character in a string</td> + </tr> + <tr> <td class="name" nowrap><a href="#get_last_modified">get_last_modified (path)</a></td> <td class="summary">Get last modified time of a file</td> </tr> @@ -86,10 +90,6 @@ <td class="summary">Obvious.</td> </tr> <tr> - <td class="name" nowrap><a href="#percent_or_hex">percent_or_hex (v)</a></td> - <td class="summary">Obvious.</td> - </tr> - <tr> <td class="name" nowrap><a href="#watch_file">watch_file (path, callback, ...)</a></td> <td class="summary">Watch a file for changes and execute callback</td> </tr> @@ -178,6 +178,34 @@ </dd> <dt> + <a name = "count"></a> + <strong>count (str, pattern)</strong> + </dt> + <dd> + Count the number of character in a string + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">str</span> + string + </li> + <li><span class="parameter">pattern</span> + string + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + number + </ol> + + + + +</dd> + <dt> <a name = "get_last_modified"></a> <strong>get_last_modified (path)</strong> </dt> @@ -257,31 +285,6 @@ </dd> <dt> - <a name = "percent_or_hex"></a> - <strong>percent_or_hex (v)</strong> - </dt> - <dd> - Obvious. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">v</span> - string - </li> - </ul> - - <h3>Returns:</h3> - <ol> - - number|nil - </ol> - - - - -</dd> - <dt> <a name = "watch_file"></a> <strong>watch_file (path, callback, ...)</strong> </dt> @@ -298,7 +301,7 @@ function: Callback to execute </li> <li><span class="parameter">...</span> - array: params for callback + table: params for callback </li> </ul> |