hiro/tridactyl
1
0
Fork 0
mirror of https://github.com/vale981/tridactyl synced 2025-03-06 01:51:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve autocontain excmd documentation.

Browse source
This commit is contained in:
Anton Vilhelm Ásgeirsson 2018-07-25 12:32:53 +00:00
parent 515b7f4c95
commit 369fbd56b5
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
src/excmds.ts
View file

@ -2354,14 +2354,18 @@ export function autocmd(event: string, url: string, ...excmd: string[]) {
}
/** Automatically open a domain and all its subdomains in a specified container.
@param domain The domain which will trigger the autoContain directive. Includes all subdomains.
@param container The container to open the url in.
* Note: This is an experimental feature, if you encounter issues please create an issue on github. *
For declaring containers that do not yet exist, consider using `auconscreatecontainer true` in your tridactylrc.
This allows tridactyl to automatically create containers from your autocontain directives. Note that they will be random icons and colors.
*
* For declaring containers that do not yet exist, consider using `auconscreatecontainer true` in your tridactylrc.
* This allows tridactyl to automatically create containers from your autocontain directives. Note that they will be random icons and colors.
*
* ** NB: This is an experimental feature, if you encounter issues please create an issue on github. **
*
* The domain is passed through as a regular expression so there are a few gotchas to be aware of:
* * Unescaped periods will match *anything*. `autocontain google.co.uk work` will match `google!co$uk`. Escape your periods or accept that you might get some false positives.
* * You can use regex in your domain pattern. `autocontain google\,(co\.uk|com) work` will match either `google.co.uk` or `google.com`.
*
* @param domain The domain which will trigger the autoContain directive. Includes all subdomains.
* @param container The container to open the url in.
*/
//#background
export function autocontain(domain: string, container: string) {