From b2fb7cd3d765bda9c8bb7fdee93ce7494f30cc10 Mon Sep 17 00:00:00 2001 From: Akshay Nair Date: Sun, 17 Aug 2025 16:17:13 +0530 Subject: Update internal api options --- docs/api/index.html | 245 +++++++++++++++++++++++++++++++++----------------- docs/api/symbols.json | 2 +- 2 files changed, 164 insertions(+), 83 deletions(-) (limited to 'docs') diff --git a/docs/api/index.html b/docs/api/index.html index cfa0023..79588d7 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -69,7 +69,7 @@ Get the current keymap mode - web.view.close (view_id) + web.view.close (opts) Close view @@ -81,6 +81,10 @@ Get current view id + web.view.current_url () + Get current url + + web.view.list () Get a list of views in the current window @@ -89,7 +93,7 @@ Select a view in current window - web.view.set_url (url, view_id) + web.view.set_url (url, opts) Set url of a given view @@ -102,14 +106,14 @@ web.view.reload (opts) - Relaod a given view + Reload a given view web.view.expose (name, action, opts) Expose a lua function inside a view (Only works with decorations) - web.view.open_devtools (view_id) + web.view.open_devtools (opts) Open devtools window for the view @@ -129,19 +133,19 @@ Get configuration value - web.history.back (count, view_id) + web.history.back (count, opts) Go back in history for given view - web.history.forward (count, view_id) + web.history.forward (count, opts) Go forward in history for given view - web.search.set_text (text, view_id) + web.search.set_text (text, opts) Search text inside a view - web.search.reset (view_id) + web.search.reset (opts) Reset searched text in a view (Same as web.search.set_text('')) @@ -149,23 +153,23 @@ Get the last searched text - web.search.next (view_id) + web.search.next (opts) Highlight next search term for the last searched text - web.search.previous (view_id) + web.search.previous (opts) Highlight previous search term for the last searched text - web.view.scroll (deltax, deltay, view_id) + web.view.scroll (deltax, deltay, opts) TODO: Document - web.view.scroll_to_top (view_id) + web.view.scroll_to_top (opts) TODO: Document - web.view.scroll_to_bottom (view_id) + web.view.scroll_to_bottom (opts) TODO: Document @@ -383,7 +387,7 @@
- web.view.close (view_id) + web.view.close (opts)
Close view @@ -391,9 +395,12 @@

Parameters:

@@ -402,7 +409,7 @@

Usage:

@@ -454,6 +461,30 @@ 
local view_id = web.view.current()
+ +
+ + web.view.current_url () +
+
+ Get current url + + + +

Returns:

+
    + + string + Current view url +
+ + + +

Usage:

+ +
@@ -507,7 +538,7 @@
- web.view.set_url (url, view_id) + web.view.set_url (url, opts)
Set url of a given view @@ -519,10 +550,12 @@ string Url to open -
  • view_id - number - View id to select +
  • opts Options +
      +
    • view + number? View id (default = 0)
      • +
    @@ -531,7 +564,7 @@

    Usage:

      web.view.set_url('https://foobar.com')
-web.view.set_url('https://foobar.com', 3) -- Set url for view with id 3
      +web.view.set_url('https://foobar.com', { view = 3 }) -- Set url for view with id 3
    • @@ -546,12 +579,12 @@ web.view.set_url('https:

    Parameters:

    @@ -578,11 +611,17 @@ web.view.set_html('<h
    • js string - HTML string + JS string +
      • +
    • opts Options +
        +
      • view + number? View id (default = 0)
        • -
      • opts - ? RunJSOpts Options +
      • on_result + ? fun(v: any): nil Callback with serialized result of evaluation
        • +
    @@ -591,7 +630,12 @@ web.view.set_html('<h

    Usage:

      web.view.run_js('console.log(42)')
-web.view.run_js('console.log(42)', { view = 3 }) -- Set html for view with id 3
      +web.view.run_js('console.log(42)', { view = 3 }) -- Set html for view with id 3 +web.view.run_js('2 * 3', { + on_result = function(result) + print(result * 7) + end, +})
    @@ -600,14 +644,17 @@ web.view.run_js('console web.view.reload (opts)
    - Relaod a given view + Reload a given view

    Parameters:

      -
    • opts - ? ReloadOpts Options +
    • opts Options +
        +
      • view + number? View id (default = 0)
        • +
    @@ -631,14 +678,17 @@ web.view.reload({ view = Parameters:
    • name - string Func name + string Func name
    • action - fun(table):nil Action to call when function is invoked in view + fun(table):nil Action to call when function is invoked in view
      • -
    • opts - ExposeOpts? Options +
    • opts Options +
        +
      • view + number? View id (default = 0)
        • +
    @@ -656,7 +706,7 @@ web.view.reload({ view =
    - web.view.open_devtools (view_id) + web.view.open_devtools (opts)
    Open devtools window for the view @@ -664,10 +714,12 @@ web.view.reload({ view = Parameters:
      -
    • view_id - number - Id of the view +
    • opts Options +
        +
      • view + number? View id (default = 0)
        • +
    @@ -809,7 +861,7 @@ web.view.reload({ view =
    - web.history.back (count, view_id) + web.history.back (count, opts)
    Go back in history for given view @@ -820,10 +872,12 @@ web.view.reload({ view = count number? Number of history items to go back in (default = 1) -
  • view_id - number - Id of the view +
  • opts Options +
      +
    • view + number? View id (default = 0)
      • +
    @@ -831,13 +885,13 @@ web.view.reload({ view = Usage:
      - 
      web.history.back(2, 3) -- Go back 2 history items for view id 3
      + 
      web.history.back(2, { view = 3 }) -- Go back 2 history items for view id 3
    • - web.history.forward (count, view_id) + web.history.forward (count, opts)
    Go forward in history for given view @@ -848,10 +902,12 @@ web.view.reload({ view = count number? Number of history items to go forward in (default = 1) -
  • view_id - number - Id of the view +
  • opts Options +
      +
    • view + number? View id (default = 0)
      • +
    @@ -859,13 +915,13 @@ web.view.reload({ view = Usage:
      - 
      web.history.forward(2, 3) -- Go forward 2 history items for view id 3
      + 
      web.history.forward(2, { view = 3 }) -- Go forward 2 history items for view id 3
    • - web.search.set_text (text, view_id) + web.search.set_text (text, opts)
    Search text inside a view @@ -876,10 +932,12 @@ web.view.reload({ view = text string? Text to search -
  • view_id - number - Id of the view +
  • opts Options +
      +
    • view + number? View id (default = 0)
      • +
    @@ -888,13 +946,13 @@ web.view.reload({ view = Usage: 
      web.search.set_text('whatever') -- Search in current view
-web.search.set_text('whatever', 5) -- Search in view id 5
      +web.search.set_text('whatever', { view = 5 }) -- Search in view id 5
    • - web.search.reset (view_id) + web.search.reset (opts)
    Reset searched text in a view (Same as web.search.set_text('')) @@ -902,10 +960,12 @@ web.view.reload({ view = Parameters:
      -
    • view_id - number - Id of the view +
    • opts Options +
        +
      • view + number? View id (default = 0)
        • +
    @@ -914,7 +974,7 @@ web.view.reload({ view = Usage: 
      web.search.reset() -- Reset search state for current view
-web.search.reset(5) -- Reset search state for view id 5
      +web.search.reset({ view = 5 }) -- Reset search state for view id 5
    @@ -938,7 +998,7 @@ web.view.reload({ view =
    - web.search.next (view_id) + web.search.next (opts)
    Highlight next search term for the last searched text @@ -946,10 +1006,12 @@ web.view.reload({ view = Parameters:
      -
    • view_id - number - Id of the view +
    • opts Options +
        +
      • view + number? View id (default = 0)
        • +
    @@ -958,13 +1020,13 @@ web.view.reload({ view = Usage: 
      web.search.next() -- Next search result in current view
-web.search.next(5) -- Next search result in view id 5
      +web.search.next({ view = 5 }) -- Next search result in view id 5
    - web.search.previous (view_id) + web.search.previous (opts)
    Highlight previous search term for the last searched text @@ -972,10 +1034,12 @@ web.view.reload({ view = Parameters:
      -
    • view_id - number - Id of the view +
    • opts Options +
        +
      • view + number? View id (default = 0)
        • +
    @@ -990,7 +1054,7 @@ web.view.reload({ view =
    - web.view.scroll (deltax, deltay, view_id) + web.view.scroll (deltax, deltay, opts)
    TODO: Document @@ -999,14 +1063,19 @@ web.view.reload({ view = Parameters:
    • deltax + number
    • deltay + number
      • -
    • view_id - +
    • opts Options +
        +
      • view + number? View id (default = 0)
        • +
    @@ -1016,7 +1085,7 @@ web.view.reload({ view =
    - web.view.scroll_to_top (view_id) + web.view.scroll_to_top (opts)
    TODO: Document @@ -1024,9 +1093,12 @@ web.view.reload({ view = Parameters:
      -
    • view_id - +
    • opts Options +
        +
      • view + number? View id (default = 0)
        • +
    @@ -1036,7 +1108,7 @@ web.view.reload({ view =
    - web.view.scroll_to_bottom (view_id) + web.view.scroll_to_bottom (opts)
    TODO: Document @@ -1044,9 +1116,12 @@ web.view.reload({ view = Parameters:
      -
    • view_id - +
    • opts Options +
        +
      • view + number? View id (default = 0)
        • +
    @@ -1063,6 +1138,12 @@ web.view.reload({ view = Returns: +
      + + table + help_items List of help item names +
    @@ -1080,12 +1161,12 @@ web.view.reload({ view =
  • item string - + Help item name
    • -
  • opts +
  • opts Options
    • view - number? + number? View id (default = 0)
    @@ -1166,7 +1247,7 @@ web.view.reload({ view = opts Options
    • null - any What to use as null value (default: nil) + any? What to use as null value (default: nil)
    diff --git a/docs/api/symbols.json b/docs/api/symbols.json index 8b5319e..baf9a1e 100644 --- a/docs/api/symbols.json +++ b/docs/api/symbols.json @@ -1 +1 @@ -["_G.__internals","schedule","web.keymap.set","web.keymap.set_mode","web.keymap.get_mode","web.view.close","web.view.create","web.view.current","web.view.list","web.view.select","web.view.set_url","web.view.set_html","web.view.run_js","web.view.reload","web.view.expose","web.view.open_devtools","web.view.current_index","web.event.add_listener","set","get","WebOpts","opts","web.history.back","web.history.forward","web.search.set_text","web.search.reset","web.search.get_text","web.search.next","web.search.previous","web.view.scroll","web.view.scroll_to_top","web.view.scroll_to_bottom","web.help.get_items","web.help.show","WebEvents","WinCreatedEventOpts","ViewCreatedEventOpts","ViewSelectedEventOpts","ViewClosedEventOpts","UrlChangedEventOpts","PermissionRequestedEventOpts","ModeChangedEventOpts","KeyPressedEventOpts","NotificationReceivedEventOpts","uv","inspect","print","web.json.encode","web.json.decode","web.utils.string_trim","web.utils.table_merge","web.utils.table_keys","web.utils.equals","web.utils.table_contains"] \ No newline at end of file +["_G.__internals","schedule","web.keymap.set","web.keymap.set_mode","web.keymap.get_mode","web.view.close","web.view.create","web.view.current","web.view.current_url","web.view.list","web.view.select","web.view.set_url","web.view.set_html","web.view.run_js","web.view.reload","web.view.expose","web.view.open_devtools","web.view.current_index","web.event.add_listener","set","get","WebOpts","opts","web.history.back","web.history.forward","web.search.set_text","web.search.reset","web.search.get_text","web.search.next","web.search.previous","web.view.scroll","web.view.scroll_to_top","web.view.scroll_to_bottom","web.help.get_items","web.help.show","WebEvents","WinCreatedEventOpts","ViewCreatedEventOpts","ViewSelectedEventOpts","ViewClosedEventOpts","UrlChangedEventOpts","PermissionRequestedEventOpts","ModeChangedEventOpts","KeyPressedEventOpts","NotificationReceivedEventOpts","uv","inspect","print","web.json.encode","web.json.decode","web.utils.string_trim","web.utils.table_merge","web.utils.table_keys","web.utils.equals","web.utils.table_contains"] \ No newline at end of file -- cgit v1.3.1