Debian Codegraph @

docs/.vuepress/public/2.4/examples/js_api.html

raw
1 <!DOCTYPE html>
2 <html lang="en-US">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width,initial-scale=1">
6 <title>Javascript API | pywebview (v2.4)</title>
7 <meta name="description" content="Build GUI for your Python program with JavaScript, HTML, and CSS">
8
9
10 <link rel="preload" href="/2.4/assets/css/0.styles.e542dfbb.css" as="style"><link rel="preload" href="/2.4/assets/js/app.ab883ad2.js" as="script"><link rel="preload" href="/2.4/assets/js/18.7b4619dc.js" as="script"><link rel="prefetch" href="/2.4/assets/js/10.946430c0.js"><link rel="prefetch" href="/2.4/assets/js/11.9f37de77.js"><link rel="prefetch" href="/2.4/assets/js/12.cc649247.js"><link rel="prefetch" href="/2.4/assets/js/13.94ca571d.js"><link rel="prefetch" href="/2.4/assets/js/14.a047eef4.js"><link rel="prefetch" href="/2.4/assets/js/15.788bb271.js"><link rel="prefetch" href="/2.4/assets/js/16.694894b2.js"><link rel="prefetch" href="/2.4/assets/js/17.2edfeaf2.js"><link rel="prefetch" href="/2.4/assets/js/19.ec102f84.js"><link rel="prefetch" href="/2.4/assets/js/2.06af3526.js"><link rel="prefetch" href="/2.4/assets/js/20.b1804ec3.js"><link rel="prefetch" href="/2.4/assets/js/21.82f7ca23.js"><link rel="prefetch" href="/2.4/assets/js/22.0e759d36.js"><link rel="prefetch" href="/2.4/assets/js/23.8e7b242c.js"><link rel="prefetch" href="/2.4/assets/js/24.720f51e9.js"><link rel="prefetch" href="/2.4/assets/js/25.3af86868.js"><link rel="prefetch" href="/2.4/assets/js/26.562c94d4.js"><link rel="prefetch" href="/2.4/assets/js/27.7c95cefd.js"><link rel="prefetch" href="/2.4/assets/js/28.d5836b93.js"><link rel="prefetch" href="/2.4/assets/js/29.528821ab.js"><link rel="prefetch" href="/2.4/assets/js/3.c462cbf1.js"><link rel="prefetch" href="/2.4/assets/js/30.e6e32fda.js"><link rel="prefetch" href="/2.4/assets/js/31.c651468e.js"><link rel="prefetch" href="/2.4/assets/js/32.6c8529fe.js"><link rel="prefetch" href="/2.4/assets/js/33.96fe48c6.js"><link rel="prefetch" href="/2.4/assets/js/34.1503f1f8.js"><link rel="prefetch" href="/2.4/assets/js/35.2c565ae8.js"><link rel="prefetch" href="/2.4/assets/js/36.60799f3e.js"><link rel="prefetch" href="/2.4/assets/js/37.5656488c.js"><link rel="prefetch" href="/2.4/assets/js/38.30116eb6.js"><link rel="prefetch" href="/2.4/assets/js/39.8b7a8ec5.js"><link rel="prefetch" href="/2.4/assets/js/4.cc18902f.js"><link rel="prefetch" href="/2.4/assets/js/40.14c37596.js"><link rel="prefetch" href="/2.4/assets/js/5.b85830ed.js"><link rel="prefetch" href="/2.4/assets/js/6.fe285e19.js"><link rel="prefetch" href="/2.4/assets/js/7.5eeb60d8.js"><link rel="prefetch" href="/2.4/assets/js/8.b9ad99cd.js"><link rel="prefetch" href="/2.4/assets/js/9.6a770a26.js">
11 <link rel="stylesheet" href="/2.4/assets/css/0.styles.e542dfbb.css">
12 </head>
13 <body>
14 <div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/2.4/" class="home-link router-link-active"><!----> <span class="site-name">pywebview (v2.4)</span></a> <div class="links" style="max-width:nullpx;"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/2.4/guide/" class="nav-link">Guide</a></div><div class="nav-item"><a href="/2.4/examples/" class="nav-link router-link-active">Examples</a></div><div class="nav-item"><a href="/2.4/contributing/" class="nav-link">Contributing</a></div><div class="nav-item"><a href="https://pywebview.flowrl.com/" target="_blank" rel="noopener noreferrer" class="nav-link external">
15 Current version
16 <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div><div class="nav-item"><a href="https://github.com/r0x0r/pywebview/blob/master/CHANGELOG.md" target="_blank" rel="noopener noreferrer" class="nav-link external">
17 Changelog
18 <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <a href="https://github.com/r0x0r/pywebview" target="_blank" rel="noopener noreferrer" class="repo-link">
19 GitHub
20 <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav></div></header> <div class="sidebar-mask"></div> <div class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/2.4/guide/" class="nav-link">Guide</a></div><div class="nav-item"><a href="/2.4/examples/" class="nav-link router-link-active">Examples</a></div><div class="nav-item"><a href="/2.4/contributing/" class="nav-link">Contributing</a></div><div class="nav-item"><a href="https://pywebview.flowrl.com/" target="_blank" rel="noopener noreferrer" class="nav-link external">
21 Current version
22 <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div><div class="nav-item"><a href="https://github.com/r0x0r/pywebview/blob/master/CHANGELOG.md" target="_blank" rel="noopener noreferrer" class="nav-link external">
23 Changelog
24 <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <a href="https://github.com/r0x0r/pywebview" target="_blank" rel="noopener noreferrer" class="repo-link">
25 GitHub
26 <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav> <ul class="sidebar-links"><li><a href="/2.4/examples/change_url.html" class="sidebar-link">Change URL</a></li><li><a href="/2.4/examples/css_load.html" class="sidebar-link">CSS load</a></li><li><a href="/2.4/examples/debug.html" class="sidebar-link">Debugging</a></li><li><a href="/2.4/examples/destroy_window.html" class="sidebar-link">Destroy window</a></li><li><a href="/2.4/examples/fullscreen.html" class="sidebar-link">Fullscreen window</a></li><li><a href="/2.4/examples/get_current_url.html" class="sidebar-link">Get current URL</a></li><li><a href="/2.4/examples/html_load.html" class="sidebar-link">HTML load</a></li><li><a href="/2.4/examples/js_evaluate.html" class="sidebar-link">Javascript evaluation</a></li><li><a href="/2.4/examples/js_api.html" class="active sidebar-link">Javascript API</a></li><li><a href="/2.4/examples/loading_animation.html" class="sidebar-link">Loading animation</a></li><li><a href="/2.4/examples/localization.html" class="sidebar-link">Localization</a></li><li><a href="/2.4/examples/min_size.html" class="sidebar-link">Minimum window size</a></li><li><a href="/2.4/examples/multiple_windows.html" class="sidebar-link">Multi-window</a></li><li><a href="/2.4/examples/open_file_dialog.html" class="sidebar-link">Open file dialog</a></li><li><a href="/2.4/examples/open_url.html" class="sidebar-link">Open URL</a></li><li><a href="/2.4/examples/quit_confirm.html" class="sidebar-link">Quit confirmation dialog</a></li><li><a href="/2.4/examples/save_file_dialog.html" class="sidebar-link">Save file dialog</a></li><li><a href="/2.4/examples/toggle_fullscreen.html" class="sidebar-link">Toggle full-screen</a></li><li><a href="/2.4/examples/window_title_change.html" class="sidebar-link">Window title change</a></li></ul> </div> <div class="page"> <div class="content"><h1 id="javascript-api"><a href="#javascript-api" aria-hidden="true" class="header-anchor">#</a> Javascript API</h1> <p>Create an application without a HTTP server. The application uses Javascript API object to communicate between Python and Javascript.</p> <div class="language-python extra-class"><pre class="language-python"><code><span class="token keyword">import</span> webview
27 <span class="token keyword">import</span> threading
28 <span class="token keyword">import</span> time
29 <span class="token keyword">import</span> sys
30 <span class="token keyword">import</span> random
31
32
33 html <span class="token operator">=</span> <span class="token triple-quoted-string string">&quot;&quot;&quot;
34 &lt;!DOCTYPE html&gt;
35 &lt;html&gt;
36 &lt;head lang=&quot;en&quot;&gt;
37 &lt;meta charset=&quot;UTF-8&quot;&gt;
38
39 &lt;style&gt;
40 #response-container {
41 display: none;
42 padding: 3rem;
43 margin: 3rem 5rem;
44 font-size: 120%;
45 border: 5px dashed #ccc;
46 }
47
48 label {
49 margin-left: 0.3rem;
50 margin-right: 0.3rem;
51 }
52
53 button {
54 font-size: 100%;
55 padding: 0.5rem;
56 margin: 0.3rem;
57 text-transform: uppercase;
58 }
59
60 &lt;/style&gt;
61 &lt;/head&gt;
62 &lt;body&gt;
63
64
65 &lt;h1&gt;JS API Example&lt;/h1&gt;
66 &lt;button onClick=&quot;initialize()&quot;&gt;Hello Python&lt;/button&gt;&lt;br/&gt;
67 &lt;button id=&quot;heavy-stuff-btn&quot; onClick=&quot;doHeavyStuff()&quot;&gt;Perform a heavy operation&lt;/button&gt;&lt;br/&gt;
68 &lt;button onClick=&quot;getRandomNumber()&quot;&gt;Get a random number&lt;/button&gt;&lt;br/&gt;
69 &lt;label for=&quot;name_input&quot;&gt;Say hello to:&lt;/label&gt;&lt;input id=&quot;name_input&quot; placeholder=&quot;put a name here&quot;&gt;
70 &lt;button onClick=&quot;greet()&quot;&gt;Greet&lt;/button&gt;&lt;br/&gt;
71
72 &lt;div id=&quot;response-container&quot;&gt;&lt;/div&gt;
73 &lt;script&gt;
74 function showResponse(response) {
75 var container = document.getElementById('response-container')
76
77 container.innerText = response.message
78 container.style.display = 'block'
79 }
80
81 function initialize() {
82 pywebview.api.init().then(showResponse)
83 }
84
85 function doHeavyStuff() {
86 var btn = document.getElementById('heavy-stuff-btn')
87
88 pywebview.api.doHeavyStuff().then(function(response) {
89 showResponse(response)
90 btn.onclick = doHeavyStuff
91 btn.innerText = 'Perform a heavy operation'
92 })
93
94 showResponse({message: 'Working...'})
95 btn.innerText = 'Cancel the heavy operation'
96 btn.onclick = cancelHeavyStuff
97 }
98
99 function cancelHeavyStuff() {
100 pywebview.api.cancelHeavyStuff()
101 }
102
103 function getRandomNumber() {
104 pywebview.api.getRandomNumber().then(showResponse)
105 }
106
107 function greet() {
108 var name_input = document.getElementById('name_input').value;
109 pywebview.api.sayHelloTo(name_input).then(showResponse)
110 }
111
112 &lt;/script&gt;
113 &lt;/body&gt;
114 &lt;/html&gt;
115 &quot;&quot;&quot;</span>
116
117
118 <span class="token keyword">class</span> <span class="token class-name">Api</span><span class="token punctuation">:</span>
119 <span class="token keyword">def</span> <span class="token function">__init__</span><span class="token punctuation">(</span>self<span class="token punctuation">)</span><span class="token punctuation">:</span>
120 self<span class="token punctuation">.</span>cancel_heavy_stuff_flag <span class="token operator">=</span> <span class="token boolean">False</span>
121
122 <span class="token keyword">def</span> <span class="token function">init</span><span class="token punctuation">(</span>self<span class="token punctuation">,</span> params<span class="token punctuation">)</span><span class="token punctuation">:</span>
123 response <span class="token operator">=</span> <span class="token punctuation">{</span>
124 <span class="token string">'message'</span><span class="token punctuation">:</span> <span class="token string">'Hello from Python {0}'</span><span class="token punctuation">.</span><span class="token builtin">format</span><span class="token punctuation">(</span>sys<span class="token punctuation">.</span>version<span class="token punctuation">)</span>
125 <span class="token punctuation">}</span>
126 <span class="token keyword">return</span> response
127
128 <span class="token keyword">def</span> <span class="token function">getRandomNumber</span><span class="token punctuation">(</span>self<span class="token punctuation">,</span> params<span class="token punctuation">)</span><span class="token punctuation">:</span>
129 response <span class="token operator">=</span> <span class="token punctuation">{</span>
130 <span class="token string">'message'</span><span class="token punctuation">:</span> <span class="token string">'Here is a random number courtesy of randint: {0}'</span><span class="token punctuation">.</span><span class="token builtin">format</span><span class="token punctuation">(</span>random<span class="token punctuation">.</span>randint<span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">100000000</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
131 <span class="token punctuation">}</span>
132 <span class="token keyword">return</span> response
133
134 <span class="token keyword">def</span> <span class="token function">doHeavyStuff</span><span class="token punctuation">(</span>self<span class="token punctuation">,</span> params<span class="token punctuation">)</span><span class="token punctuation">:</span>
135 time<span class="token punctuation">.</span>sleep<span class="token punctuation">(</span><span class="token number">0.1</span><span class="token punctuation">)</span> <span class="token comment"># sleep to prevent from the ui thread from freezing for a moment</span>
136 now <span class="token operator">=</span> time<span class="token punctuation">.</span>time<span class="token punctuation">(</span><span class="token punctuation">)</span>
137 self<span class="token punctuation">.</span>cancel_heavy_stuff_flag <span class="token operator">=</span> <span class="token boolean">False</span>
138 <span class="token keyword">for</span> i <span class="token keyword">in</span> <span class="token builtin">range</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">1000000</span><span class="token punctuation">)</span><span class="token punctuation">:</span>
139 _ <span class="token operator">=</span> i <span class="token operator">*</span> random<span class="token punctuation">.</span>randint<span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">1000</span><span class="token punctuation">)</span>
140 <span class="token keyword">if</span> self<span class="token punctuation">.</span>cancel_heavy_stuff_flag<span class="token punctuation">:</span>
141 response <span class="token operator">=</span> <span class="token punctuation">{</span><span class="token string">'message'</span><span class="token punctuation">:</span> <span class="token string">'Operation cancelled'</span><span class="token punctuation">}</span>
142 <span class="token keyword">break</span>
143 <span class="token keyword">else</span><span class="token punctuation">:</span>
144 then <span class="token operator">=</span> time<span class="token punctuation">.</span>time<span class="token punctuation">(</span><span class="token punctuation">)</span>
145 response <span class="token operator">=</span> <span class="token punctuation">{</span>
146 <span class="token string">'message'</span><span class="token punctuation">:</span> <span class="token string">'Operation took {0:.1f} seconds on the thread {1}'</span><span class="token punctuation">.</span><span class="token builtin">format</span><span class="token punctuation">(</span><span class="token punctuation">(</span>then <span class="token operator">-</span> now<span class="token punctuation">)</span><span class="token punctuation">,</span> threading<span class="token punctuation">.</span>current_thread<span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
147 <span class="token punctuation">}</span>
148 <span class="token keyword">return</span> response
149
150 <span class="token keyword">def</span> <span class="token function">cancelHeavyStuff</span><span class="token punctuation">(</span>self<span class="token punctuation">,</span> params<span class="token punctuation">)</span><span class="token punctuation">:</span>
151 time<span class="token punctuation">.</span>sleep<span class="token punctuation">(</span><span class="token number">0.1</span><span class="token punctuation">)</span>
152 self<span class="token punctuation">.</span>cancel_heavy_stuff_flag <span class="token operator">=</span> <span class="token boolean">True</span>
153
154 <span class="token keyword">def</span> <span class="token function">sayHelloTo</span><span class="token punctuation">(</span>self<span class="token punctuation">,</span> params<span class="token punctuation">)</span><span class="token punctuation">:</span>
155 response <span class="token operator">=</span> <span class="token punctuation">{</span>
156 <span class="token string">'message'</span><span class="token punctuation">:</span> <span class="token string">'Hello {0}!'</span><span class="token punctuation">.</span><span class="token builtin">format</span><span class="token punctuation">(</span>params<span class="token punctuation">)</span>
157 <span class="token punctuation">}</span>
158 <span class="token keyword">return</span> response
159
160
161 <span class="token keyword">def</span> <span class="token function">create_app</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span>
162 webview<span class="token punctuation">.</span>load_html<span class="token punctuation">(</span>html<span class="token punctuation">)</span>
163
164
165 <span class="token keyword">if</span> __name__ <span class="token operator">==</span> <span class="token string">'__main__'</span><span class="token punctuation">:</span>
166 t <span class="token operator">=</span> threading<span class="token punctuation">.</span>Thread<span class="token punctuation">(</span>target<span class="token operator">=</span>create_app<span class="token punctuation">)</span>
167 t<span class="token punctuation">.</span>start<span class="token punctuation">(</span><span class="token punctuation">)</span>
168
169 api <span class="token operator">=</span> Api<span class="token punctuation">(</span><span class="token punctuation">)</span>
170 webview<span class="token punctuation">.</span>create_window<span class="token punctuation">(</span><span class="token string">'API example'</span><span class="token punctuation">,</span> js_api<span class="token operator">=</span>api<span class="token punctuation">)</span>
171 </code></pre></div></div> <div class="page-edit"><div class="edit-link"><a href="https://github.com/r0x0r/pywebview/edit/docs/docs/examples/js_api.md" target="_blank" rel="noopener noreferrer">Help us improve this page!</a> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></div> <!----></div> <div class="page-nav"><p class="inner"><span class="prev">
172 ←
173 <a href="/2.4/examples/js_evaluate.html" class="prev">
174 Javascript evaluation
175 </a></span> <span class="next"><a href="/2.4/examples/loading_animation.html">
176 Loading animation
177 </a>
178 →
179 </span></p></div> </div> <!----></div></div>
180 <script src="/2.4/assets/js/app.ab883ad2.js" defer></script><script src="/2.4/assets/js/18.7b4619dc.js" defer></script>
181 </body>
182 </html>