Class: Ruflet::UI::Controls::RufletComponents::WebViewControl

Inherits:

Control

Object
Control
Ruflet::UI::Controls::RufletComponents::WebViewControl

show all

Defined in:: lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb

Overview

WebView control — parity with Flet's WebView (https://flet.dev/docs/controls/webview/).

Properties: url, bgcolor, prevent_links, plus the usual layout props. Events: on_page_started, on_page_ended, on_web_resource_error, on_progress, on_url_change, on_scroll, on_console_message, on_javascript_alert_dialog. Methods (invoked over the wire on a mounted control): reload, go_back, go_forward, can_go_back, can_go_forward, run_javascript, load_html, load_request, load_file, scroll_to, scroll_by, clear_cache, clear_local_storage, enable_zoom, disable_zoom, set_javascript_mode, get_current_url, get_title, get_user_agent.

Platform note: the native webview (and therefore run_javascript and the events/methods) runs on iOS, Android and macOS. On web it falls back to an , which cannot run the methods and which most external sites block via X-Frame-Options/CSP — embed your own same-origin pages there. </div> </div> <div class="tags"> </div> <h2> Constant Summary <a href="#" class="constants_summary_toggle">collapse</a> </h2> <dl class="constants"> <dt id="TYPE-constant" class="">TYPE = </dt> <dd><pre class="code">"WebView".freeze</pre></dd> <dt id="WIRE-constant" class="">WIRE = </dt> <dd><pre class="code">"WebView".freeze</pre></dd> </dl> <h3 class="inherited">Constants inherited from <a href="../../../Control.html" title="Ruflet::Control (class)">Control</a></h3> <a href="../../../Control.html#HOST_EXPANDED_TYPES-constant" title="Ruflet::Control::HOST_EXPANDED_TYPES (constant)">Control::HOST_EXPANDED_TYPES</a> <h2>Instance Attribute Summary</h2> <h3 class="inherited">Attributes inherited from <a href="../../../Control.html" title="Ruflet::Control (class)">Control</a></h3> <a href="../../../Control.html#children-instance_method" title="Ruflet::Control#children (method)">#children</a>, <a href="../../../Control.html#id-instance_method" title="Ruflet::Control#id (method)">#id</a>, <a href="../../../Control.html#props-instance_method" title="Ruflet::Control#props (method)">#props</a>, <a href="../../../Control.html#runtime_page-instance_method" title="Ruflet::Control#runtime_page (method)">#runtime_page</a>, <a href="../../../Control.html#type-instance_method" title="Ruflet::Control#type (method)">#type</a>, <a href="../../../Control.html#wire_id-instance_method" title="Ruflet::Control#wire_id (method)">#wire_id</a> <h2> Instance Method Summary <a href="#" class="summary_toggle">collapse</a> </h2> <ul class="summary"> <li class="public "> <a href="#can_go_back-instance_method" title="#can_go_back (instance method)">#can_go_back(timeout: 10, &on_result) ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#can_go_forward-instance_method" title="#can_go_forward (instance method)">#can_go_forward(timeout: 10, &on_result) ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#clear_cache-instance_method" title="#clear_cache (instance method)">#clear_cache ⇒ Object </a> <div class='inline'>--- Storage / zoom ----------------------------------------------.</div> </li> <li class="public "> <a href="#clear_local_storage-instance_method" title="#clear_local_storage (instance method)">#clear_local_storage ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#disable_zoom-instance_method" title="#disable_zoom (instance method)">#disable_zoom ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#enable_zoom-instance_method" title="#enable_zoom (instance method)">#enable_zoom ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#get_current_url-instance_method" title="#get_current_url (instance method)">#get_current_url(timeout: 10, &on_result) ⇒ Object </a> <div class='inline'>--- Introspection (result delivered to the block) ---------------.</div> </li> <li class="public "> <a href="#get_title-instance_method" title="#get_title (instance method)">#get_title(timeout: 10, &on_result) ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#get_user_agent-instance_method" title="#get_user_agent (instance method)">#get_user_agent(timeout: 10, &on_result) ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#go_back-instance_method" title="#go_back (instance method)">#go_back ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#go_forward-instance_method" title="#go_forward (instance method)">#go_forward ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#initialize-instance_method" title="#initialize (instance method)">#initialize(id: nil, bgcolor: nil, data: nil, enable_javascript: nil, expand: nil, height: nil, key: nil, method: nil, opacity: nil, prevent_links: nil, rtl: nil, tooltip: nil, url: nil, visible: nil, width: nil, on_page_ended: nil, on_page_started: nil, on_web_resource_error: nil, on_progress: nil, on_url_change: nil, on_scroll: nil, on_console_message: nil, on_javascript_alert_dialog: nil) ⇒ WebViewControl </a> constructor <div class='inline'>A new instance of WebViewControl.</div> </li> <li class="public "> <a href="#load_file-instance_method" title="#load_file (instance method)">#load_file(path) ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#load_html-instance_method" title="#load_html (instance method)">#load_html(value, base_url: nil) ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#load_request-instance_method" title="#load_request (instance method)">#load_request(url, method: "get") ⇒ Object </a> <div class='inline'>--- Loading content ---------------------------------------------.</div> </li> <li class="public "> <a href="#reload-instance_method" title="#reload (instance method)">#reload ⇒ Object </a> <div class='inline'>--- Navigation --------------------------------------------------.</div> </li> <li class="public "> <a href="#run_javascript-instance_method" title="#run_javascript (instance method)">#run_javascript(value) ⇒ Object </a> <div class='inline'>Run arbitrary JS inside the page — e.g.</div> </li> <li class="public "> <a href="#scroll_by-instance_method" title="#scroll_by (instance method)">#scroll_by(x, y) ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#scroll_to-instance_method" title="#scroll_to (instance method)">#scroll_to(x, y) ⇒ Object </a> <div class='inline'>--- Scrolling ---------------------------------------------------.</div> </li> <li class="public "> <a href="#set_javascript_mode-instance_method" title="#set_javascript_mode (instance method)">#set_javascript_mode(mode) ⇒ Object </a> <div class='inline'></div> </li> </ul> <h3 class="inherited">Methods inherited from <a href="../../../Control.html" title="Ruflet::Control (class)">Control</a></h3> <a href="../../../Control.html#[]-instance_method" title="Ruflet::Control#[] (method)">#[]</a>, <a href="../../../Control.html#[]=-instance_method" title="Ruflet::Control#[]= (method)">#[]=</a>, <a href="../../../Control.html#emit-instance_method" title="Ruflet::Control#emit (method)">#emit</a>, <a href="../../../Control.html#generate_id-class_method" title="Ruflet::Control.generate_id (method)">generate_id</a>, <a href="../../../Control.html#has_handler%3F-instance_method" title="Ruflet::Control#has_handler? (method)">#has_handler?</a>, <a href="../../../Control.html#method_missing-instance_method" title="Ruflet::Control#method_missing (method)">#method_missing</a>, <a href="../../../Control.html#on-instance_method" title="Ruflet::Control#on (method)">#on</a>, <a href="../../../Control.html#respond_to_missing%3F-instance_method" title="Ruflet::Control#respond_to_missing? (method)">#respond_to_missing?</a>, <a href="../../../Control.html#to_patch-instance_method" title="Ruflet::Control#to_patch (method)">#to_patch</a> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> #initialize(id: nil, bgcolor: nil, data: nil, enable_javascript: nil, expand: nil, height: nil, key: nil, method: nil, opacity: nil, prevent_links: nil, rtl: nil, tooltip: nil, url: nil, visible: nil, width: nil, on_page_ended: nil, on_page_started: nil, on_web_resource_error: nil, on_progress: nil, on_url_change: nil, on_scroll: nil, on_console_message: nil, on_javascript_alert_dialog: nil) ⇒ <tt><a href="" title="Ruflet::UI::Controls::RufletComponents::WebViewControl (class)">WebViewControl</a></tt> </h3><div class="docstring"> <div class="discussion"> Returns a new instance of WebViewControl. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 28 def initialize(id: nil, bgcolor: nil, data: nil, enable_javascript: nil, expand: nil, height: nil, key: nil, method: nil, opacity: nil, prevent_links: nil, rtl: nil, tooltip: nil, url: nil, visible: nil, width: nil, on_page_ended: nil, on_page_started: nil, on_web_resource_error: nil, on_progress: nil, on_url_change: nil, on_scroll: nil, on_console_message: nil, on_javascript_alert_dialog: nil) props = {} props[:bgcolor] = bgcolor unless bgcolor.nil? props[:data] = data unless data.nil? props[:enable_javascript] = enable_javascript unless enable_javascript.nil? props[:expand] = expand unless expand.nil? props[:height] = height unless height.nil? props[:key] = key unless key.nil? props[:method] = method unless method.nil? props[:opacity] = opacity unless opacity.nil? props[:prevent_links] = prevent_links unless prevent_links.nil? props[:rtl] = rtl unless rtl.nil? props[:tooltip] = tooltip unless tooltip.nil? props[:url] = url unless url.nil? props[:visible] = visible unless visible.nil? props[:width] = width unless width.nil? props[:on_page_ended] = on_page_ended unless on_page_ended.nil? props[:on_page_started] = on_page_started unless on_page_started.nil? props[:on_web_resource_error] = on_web_resource_error unless on_web_resource_error.nil? props[:on_progress] = on_progress unless on_progress.nil? props[:on_url_change] = on_url_change unless on_url_change.nil? props[:on_scroll] = on_scroll unless on_scroll.nil? props[:on_console_message] = on_console_message unless on_console_message.nil? props[:on_javascript_alert_dialog] = on_javascript_alert_dialog unless on_javascript_alert_dialog.nil? super(type: <a href="#TYPE-constant" title="Ruflet::UI::Controls::RufletComponents::WebViewControl::TYPE (constant)">TYPE</a>, id: id, **props) end</pre> </td> </tr> </table> </div> </div> <div id="method_missing_details" class="method_details_list"> <h2>Dynamic Method Handling</h2> This class handles dynamic methods through the <tt>method_missing</tt> method in the class <a href="../../../Control.html#method_missing-instance_method" title="Ruflet::Control#method_missing (method)">Ruflet::Control</a> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="can_go_back-instance_method"> #can_go_back(timeout: 10, &on_result) ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 66 67 68</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 66 def can_go_back(timeout: 10, &on_result) invoke_webview_method("can_go_back", timeout: timeout, on_result: on_result) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="can_go_forward-instance_method"> #can_go_forward(timeout: 10, &on_result) ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 70 71 72</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 70 def can_go_forward(timeout: 10, &on_result) invoke_webview_method("can_go_forward", timeout: timeout, on_result: on_result) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="clear_cache-instance_method"> #clear_cache ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> --- Storage / zoom ---------------------------------------------- </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 115</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 115 def clear_cache = invoke_webview_method("clear_cache")</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="clear_local_storage-instance_method"> #clear_local_storage ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 116</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 116 def clear_local_storage = invoke_webview_method("clear_local_storage")</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="disable_zoom-instance_method"> #disable_zoom ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 118</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 118 def disable_zoom = invoke_webview_method("disable_zoom")</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="enable_zoom-instance_method"> #enable_zoom ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 117</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 117 def enable_zoom = invoke_webview_method("enable_zoom")</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="get_current_url-instance_method"> #get_current_url(timeout: 10, &on_result) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> --- Introspection (result delivered to the block) --------------- </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 122 123 124</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 122 def get_current_url(timeout: 10, &on_result) invoke_webview_method("get_current_url", timeout: timeout, on_result: on_result) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="get_title-instance_method"> #get_title(timeout: 10, &on_result) ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 126 127 128</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 126 def get_title(timeout: 10, &on_result) invoke_webview_method("get_title", timeout: timeout, on_result: on_result) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="get_user_agent-instance_method"> #get_user_agent(timeout: 10, &on_result) ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 130 131 132</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 130 def get_user_agent(timeout: 10, &on_result) invoke_webview_method("get_user_agent", timeout: timeout, on_result: on_result) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="go_back-instance_method"> #go_back ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 63</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 63 def go_back = invoke_webview_method("go_back")</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="go_forward-instance_method"> #go_forward ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 64</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 64 def go_forward = invoke_webview_method("go_forward")</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="load_file-instance_method"> #load_file(path) ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 86 87 88</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 86 def load_file(path) invoke_webview_method("load_file", { "path" => path.to_s }) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="load_html-instance_method"> #load_html(value, base_url: nil) ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 80 81 82 83 84</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 80 def load_html(value, base_url: nil) args = { "value" => value.to_s } args["base_url"] = base_url.to_s unless base_url.nil? invoke_webview_method("load_html", args) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="load_request-instance_method"> #load_request(url, method: "get") ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> --- Loading content --------------------------------------------- </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 76 77 78</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 76 def load_request(url, method: "get") invoke_webview_method("load_request", { "url" => url.to_s, "method" => method.to_s }) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="reload-instance_method"> #reload ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> --- Navigation -------------------------------------------------- </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 62</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 62 def reload = invoke_webview_method("reload")</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="run_javascript-instance_method"> #run_javascript(value) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Run arbitrary JS inside the page — e.g. hide a node so a native control can take its place: <pre class="code ruby"><code class="ruby">webview.run_javascript("document.getElementById('banner').remove()")</code></pre> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 95 96 97</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 95 def run_javascript(value) invoke_webview_method("run_javascript", { "value" => value.to_s }) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="scroll_by-instance_method"> #scroll_by(x, y) ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 109 110 111</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 109 def scroll_by(x, y) invoke_webview_method("scroll_by", { "x" => x.to_i, "y" => y.to_i }) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="scroll_to-instance_method"> #scroll_to(x, y) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> --- Scrolling --------------------------------------------------- </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 105 106 107</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 105 def scroll_to(x, y) invoke_webview_method("scroll_to", { "x" => x.to_i, "y" => y.to_i }) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="set_javascript_mode-instance_method"> #set_javascript_mode(mode) ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 99 100 101</pre> </td> <td> <pre class="code"># File 'lib/ruflet_ui/ruflet/ui/controls/materials/webview_control.rb', line 99 def set_javascript_mode(mode) invoke_webview_method("set_javascript_mode", { "mode" => mode.to_s }) end</pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Wed Jul 8 02:44:46 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.44 (ruby-4.0.2). </div> </div> </body> </html>