Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "excmds_content"

Generated from excmds.ts. Don't edit this file!

Index

Variables

INPUTPASSWORD_selectors

INPUTPASSWORD_selectors: string = `input[type='password']`

Password field selectors

INPUTTAGS_selectors

INPUTTAGS_selectors: string = `input:not([disabled]):not([readonly]):-moz-any(:not([type]),[type='text'],[type='search'],[type='password'],[type='datetime'],[type='datetime-local'],[type='date'],[type='month'],[type='time'],[type='week'],[type='number'],[type='range'],[type='email'],[type='url'],[type='tel'],[type='color']),textarea:not([disabled]):not([readonly]),object,[role='application']`

The kinds of input elements that we want to be included in the "focusinput" command (gi)

LAST_USED_INPUT

LAST_USED_INPUT: HTMLElement = null

DOM reference to the last used Input field

logger

logger: Logger = new Logging.Logger('excmds')

Functions

back

  • back(n?: number): void
  • Navigate back one page in history.

    Parameters

    • Default value n: number = 1

    Returns void

focusinput

  • focusinput(nth: number | string): void
  • Focus the last used input on the page

    Parameters

    • nth: number | string

      focus the nth input on the page, or "special" inputs: "-l": last focussed input "-n": input after last focussed one "-N": input before last focussed one "-p": first password field "-b": biggest input field

    Returns void

followpage

  • followpage(rel?: "next" | "prev"): void
  • Find a likely next/previous link and follow it

    If a link or anchor element with rel=rel exists, use that, otherwise fall back to:

    1) find the last anchor on the page with innerText matching the appropriate followpagepattern. 2) call urlincrement with 1 or -1

    If you want to support e.g. French:

    set followpagepatterns.next ^(next|newer|prochain)\b|»|>>
    set followpagepatterns.prev ^(prev(ious)?|older|précédent)\b|»|>>
    

    Parameters

    • Default value rel: "next" | "prev" = "next"

      the relation of the target page to the current page: "next" or "prev"

    Returns void

forward

  • forward(n?: number): void
  • Navigate forward one page in history.

    Parameters

    • Default value n: number = 1

    Returns void

loadaucmds

  • loadaucmds(): Promise<void>
  • Returns Promise<void>

open

  • open(...urlarr: string[]): void
  • Open a new page in the current tab.

    Parameters

    • Rest ...urlarr: string[]
      • if first word looks like it has a schema, treat as a URI
      • else if the first word contains a dot, treat as a domain name
      • else if the first word is a key of [[SEARCH_URLS]], treat all following terms as search parameters for that provider
      • else treat as search parameters for google

      Related settings: "searchengine": "google" or any of [[SEARCH_URLS]]

    Returns void

scrollline

  • scrollline(n?: number): void
  • Parameters

    • Default value n: number = 1

    Returns void

scrollpage

  • scrollpage(n?: number): void
  • Parameters

    • Default value n: number = 1

    Returns void

scrollpx

  • scrollpx(a: number, b: number): void
  • Parameters

    • a: number
    • b: number

    Returns void

scrollto

  • scrollto(a: number, b?: number | "x" | "y"): void
  • If two numbers are given, treat as x and y values to give to window.scrollTo If one number is given, scroll to that percentage along a chosen axis, defaulting to the y-axis

    Parameters

    • a: number
    • Default value b: number | "x" | "y" = "y"

    Returns void

tssReadFromCss

  • tssReadFromCss(selector: string): void
  • Read text content of elements matching the given selector

    Parameters

    • selector: string

      the selector to match elements

    Returns void

ttscontrol

  • ttscontrol(action: string): Promise<void>
  • Cancel current reading and clear pending queue

    Arguments:

    • stop: cancel current and pending utterances

    Parameters

    • action: string

    Returns Promise<void>

ttsread

  • ttsread(mode: "-t" | "-c", ...args: string[]): Promise<void>
  • Read the given text using the browser's text to speech functionality and the settings currently set

    Parameters

    • mode: "-t" | "-c"

      the command mode -t read the following args as text -c read the content of elements matching the selector

    • Rest ...args: string[]

    Returns Promise<void>

unfocus

  • unfocus(): void
  • Blur (unfocus) the active element

    Returns void

urlincrement

  • urlincrement(count?: number): void
  • Increment the current tab URL

    Parameters

    • Default value count: number = 1

      the increment step, can be positive or negative

    Returns void

urlmodify

  • urlmodify(mode: "-t" | "-r" | "-q" | "-Q" | "-g", ...args: string[]): void
  • Open a URL made by modifying the current URL

    There are several modes:

    • Text replace mode: urlmodify -t <old> <new>

      Replaces the first instance of the text old with new.

      • http://example.com -> (-t exa peta) -> http://petample.com
    • Regex replacment mode: urlmodify -r <regexp> <new> [flags]

      Replaces the first match of the regexp with new. You can use flags i and g to match case-insensitively and to match all instances respectively

      • http://example.com -> (-r [ea] X g) -> http://XxXmplX.com
    • Query replace mode: urlmodify -q <query> <new_val>

      Replace the value of a query with a new one:

    • Query delete mode: urlmodify -Q <query>

      Deletes the given query (and the value if any):

      • http://e.com?id=foo&page=1 -> (-Q id) -> http://e.com?page=1
    • Graft mode: urlmodify -g <graft_point> <new_path_tail>

      "Grafts" a new tail on the URL path, possibly removing some of the old tail. Graft point indicates where the old URL is truncated before adding the new path.

      • graft_point >= 0 counts path levels, starting from the left (beginning). 0 will append from the "root", and no existing path will remain, 1 will keep one path level, and so on.
      • graft_point < 0 counts from the right (i.e. the end of the current path). -1 will append to the existing path, -2 will remove the last path level, and so on.
      http://website.com/this/is/the/path/component
      Graft point:       ^    ^  ^   ^    ^        ^
      From left:         0    1  2   3    4        5
      From right:       -6   -5 -4  -3   -2       -1
      

      Examples:

      • http://e.com/issues/42 -> (-g 0 foo) -> http://e.com/foo
      • http://e.com/issues/42 -> (-g 1 foo) -> http://e.com/issues/foo
      • http://e.com/issues/42 -> (-g -1 foo) -> http://e.com/issues/42/foo
      • http://e.com/issues/42 -> (-g -2 foo) -> http://e.com/issues/foo

    Parameters

    • mode: "-t" | "-r" | "-q" | "-Q" | "-g"

      The replace mode:

      • -t text replace
      • -r regexp replace
      • -q replace the value of the given query
      • -Q delete the given query
      • -g graft a new path onto URL or parent path of it
    • Rest ...args: string[]

    Returns void

urlparent

  • urlparent(count?: number): void
  • Go to the parent URL of the current tab's URL

    Parameters

    • Default value count: number = 1

    Returns void

urlroot

  • urlroot(): void
  • Go to the root domain of the current URL

    Returns void

Generated using TypeDoc