diff options
Diffstat (limited to 'doc/modules/colorizer.html')
-rw-r--r-- | doc/modules/colorizer.html | 109 |
1 files changed, 91 insertions, 18 deletions
diff --git a/doc/modules/colorizer.html b/doc/modules/colorizer.html index 3db15a7..e02633c 100644 --- a/doc/modules/colorizer.html +++ b/doc/modules/colorizer.html @@ -33,6 +33,7 @@ <h2>Contents</h2> <ul> <li><a href="#Functions">Functions</a></li> +<li><a href="#Tables">Tables</a></li> <li><a href="#Fields">Fields</a></li> </ul> @@ -155,6 +156,13 @@ USE WITH LUA <td class="summary">Clear the highlight cache and reload all buffers.</td> </tr> </table> +<h2><a href="#Tables">Tables</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#user_default_options">user_default_options</a></td> + <td class="summary">defaults options.</td> + </tr> +</table> <h2><a href="#Fields">Fields</a></h2> <table class="function_list"> <tr> @@ -271,8 +279,7 @@ USE WITH LUA <strong>setup (config)</strong> </dt> <dd> - -<p>Easy to use function if you want the full setup without fine grained control. + Easy to use function if you want the full setup without fine grained control. Setup an autocmd which enables colorizing for the filetypes and options specified.</p> <p>By default highlights all FileTypes.</p> @@ -288,26 +295,13 @@ Setup an autocmd which enables colorizing for the filetypes and options specifie <pre> require("colorizer").setup { filetypes = { "*" }, - user_default_options = { - RGB = true, -- #RGB hex codes - RRGGBB = true, -- #RRGGBB hex codes - names = true, -- "Name" codes like Blue or blue - RRGGBBAA = false, -- #RRGGBBAA hex codes - AARRGGBB = false, -- 0xAARRGGBB hex codes - rgb_fn = false, -- CSS rgb() and rgba() functions - hsl_fn = false, -- CSS hsl() and hsla() functions - css = false, -- Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB - css_fn = false, -- Enable all CSS *functions*: rgb_fn, hsl_fn - -- Available modes for <code>mode</code>: foreground, background, virtualtext - mode = "background", -- Set the display mode. - virtualtext = "■", - }, + user_default_options, -- all the sub-options of filetypes apply to buftypes buftypes = {}, } </pre> - +<p>For all user<em>default</em>options, see |user<em>default</em>options| <h3>Parameters:</h3> @@ -375,6 +369,85 @@ Setup an autocmd which enables colorizing for the filetypes and options specifie </dd> </dl> + <h2 class="section-header "><a name="Tables"></a>Tables</h2> + + <dl class="function"> + <dt> + <a name = "user_default_options"></a> + <strong>user_default_options</strong> + </dt> + <dd> + +<p>defaults options. </p> + +<pre> + user_default_options = { + RGB = true, -- #RGB hex codes + RRGGBB = true, -- #RRGGBB hex codes + names = true, -- "Name" codes like Blue or blue + RRGGBBAA = false, -- #RRGGBBAA hex codes + AARRGGBB = false, -- 0xAARRGGBB hex codes + rgb_fn = false, -- CSS rgb() and rgba() functions + hsl_fn = false, -- CSS hsl() and hsla() functions + css = false, -- Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB + css_fn = false, -- Enable all CSS *functions*: rgb_fn, hsl_fn + -- Available modes for <code>mode</code>: foreground, background, virtualtext + mode = "background", -- Set the display mode. + -- Available methods are false / "normal" / "lsp" / "both" + tailwind = false -- Enable tailwind colors + virtualtext = "■", + } +</pre> + + + + + <h3>Fields:</h3> + <ul> + <li><span class="parameter">RGB</span> + boolean + </li> + <li><span class="parameter">RRGGBB</span> + boolean + </li> + <li><span class="parameter">names</span> + boolean + </li> + <li><span class="parameter">RRGGBBAA</span> + boolean + </li> + <li><span class="parameter">AARRGGBB</span> + boolean + </li> + <li><span class="parameter">rgb_fn</span> + boolean + </li> + <li><span class="parameter">hsl_fn</span> + boolean + </li> + <li><span class="parameter">css</span> + boolean + </li> + <li><span class="parameter">css_fn</span> + boolean + </li> + <li><span class="parameter">mode</span> + string + </li> + <li><span class="parameter">tailwind</span> + boolean|string + </li> + <li><span class="parameter">virtualtext</span> + string + </li> + </ul> + + + + + +</dd> +</dl> <h2 class="section-header "><a name="Fields"></a>Fields</h2> <dl class="function"> @@ -404,7 +477,7 @@ Setup an autocmd which enables colorizing for the filetypes and options specifie </div> <!-- id="main" --> <div id="about"> <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> -<i style="float:right;">Last updated 2022-09-03 17:24:13 </i> +<i style="float:right;">Last updated 2022-09-06 15:06:04 </i> </div> <!-- id="about" --> </div> <!-- id="container" --> </body> |