Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(41)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/pageAction.html

Issue 545068: Allow extensions to add, remove, or change their page action popup. (Closed)
Patch Set: Rebase, to run trybots with test data in place. Created 10 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « chrome/common/extensions/api/extension_api.json ('k') | chrome/common/extensions/docs/static/pageAction.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
(...skipping 225 matching lines...) Expand 10 before | Expand all | Expand 10 after
236 </ol> 236 </ol>
237 </li> 237 </li>
238 <li> 238 <li>
239 <a href="#methods">Methods</a> 239 <a href="#methods">Methods</a>
240 <ol> 240 <ol>
241 <li> 241 <li>
242 <a href="#method-hide">hide</a> 242 <a href="#method-hide">hide</a>
243 </li><li> 243 </li><li>
244 <a href="#method-setIcon">setIcon</a> 244 <a href="#method-setIcon">setIcon</a>
245 </li><li> 245 </li><li>
246 <a href="#method-setPopup">setPopup</a>
247 </li><li>
246 <a href="#method-setTitle">setTitle</a> 248 <a href="#method-setTitle">setTitle</a>
247 </li><li> 249 </li><li>
248 <a href="#method-show">show</a> 250 <a href="#method-show">show</a>
249 </li> 251 </li>
250 </ol> 252 </ol>
251 </li> 253 </li>
252 <li> 254 <li>
253 <a href="#events">Events</a> 255 <a href="#events">Events</a>
254 <ol> 256 <ol>
255 <li> 257 <li>
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after
309 <a href="manifest.html">extension manifest</a> 311 <a href="manifest.html">extension manifest</a>
310 like this: 312 like this:
311 </p> 313 </p>
312 314
313 <pre>{ 315 <pre>{
314 "name": "My extension", 316 "name": "My extension",
315 ... 317 ...
316 <b>"page_action": { 318 <b>"page_action": {
317 "default_icon": "icons/foo.png", <em>// <b>required</b></em> 319 "default_icon": "icons/foo.png", <em>// <b>required</b></em>
318 "default_title": "Do action", <em>// optional; shown in tooltip</em> 320 "default_title": "Do action", <em>// optional; shown in tooltip</em>
319 "popup": "popup.html" <em>// optional</em> 321 "default_popup": "popup.html" <em>// optional</em>
320 }</b>, 322 }</b>,
321 ... 323 ...
322 }</pre> 324 }</pre>
323 325
324 <h2 id="ui">Parts of the UI</h2> 326 <h2 id="ui">Parts of the UI</h2>
325 327
326 <p> 328 <p>
327 Like browser actions, 329 Like browser actions,
328 page actions have an icon and 330 page actions have an icon and
329 can also have a tooltip and popup; 331 can also have a tooltip and popup;
(...skipping 436 matching lines...) Expand 10 before | Expand all | Expand 10 after
766 <div> 768 <div>
767 </div> 769 </div>
768 </div> 770 </div>
769 </dl> 771 </dl>
770 </div> 772 </div>
771 </div> 773 </div>
772 774
773 </div> <!-- /description --> 775 </div> <!-- /description -->
774 776
775 </div><div class="apiItem"> 777 </div><div class="apiItem">
778 <a name="method-setPopup"></a> <!-- method-anchor -->
779 <h4>setPopup</h4>
780
781 <div class="summary"><span style="display: none; ">void</span>
782 <!-- Note: intentionally longer 80 columns -->
783 <span>chrome.pageAction.setPopup</span>(<span class="null"><sp an style="display: none; ">, </span><span>object</span>
784 <var><span>details</span></var></span>)</div>
785
786 <div class="description">
787 <p class="todo" style="display: none; ">Undocumented.</p>
788 <p>Sets the html document to be opened as a popup when the user clicks on the page action's icon.</p>
789
790 <!-- PARAMETERS -->
791 <h4>Parameters</h4>
792 <dl>
793 <div>
794 <div>
795 <dt>
796 <var>details</var>
797 <em>
798
799 <!-- TYPE -->
800 <div style="display:inline">
801 (
802 <span class="optional" style="display: none; ">optional</spa n>
803 <span id="typeTemplate">
804 <span style="display: none; ">
805 <a> Type</a>
806 </span>
807 <span>
808 <span style="display: none; ">
809 array of <span><span></span></span>
810 </span>
811 <span>object</span>
812 </span>
813 </span>
814 )
815 </div>
816
817 </em>
818 </dt>
819 <dd class="todo">
820 Undocumented.
821 </dd>
822 <dd style="display: none; ">
823 Description of this parameter from the json schema.
824 </dd>
825
826 <!-- OBJECT PROPERTIES -->
827 <dd>
828 <dl>
829 <div>
830 <div>
831 <dt>
832 <var>tabId</var>
833 <em>
834
835 <!-- TYPE -->
836 <div style="display:inline">
837 (
838 <span class="optional" style="display: none; ">optional</spa n>
839 <span id="typeTemplate">
840 <span style="display: none; ">
841 <a> Type</a>
842 </span>
843 <span>
844 <span style="display: none; ">
845 array of <span><span></span></span>
846 </span>
847 <span>integer</span>
848 </span>
849 </span>
850 )
851 </div>
852
853 </em>
854 </dt>
855 <dd class="todo" style="display: none; ">
856 Undocumented.
857 </dd>
858 <dd>The id of the tab for which you want to modify the page action.</d d>
859
860 <!-- OBJECT PROPERTIES -->
861 <dd style="display: none; ">
862 <dl>
863 <div>
864 <div>
865 </div>
866 </div>
867 </dl>
868 </dd>
869 </div>
870 </div><div>
871 <div>
872 <dt>
873 <var>popup</var>
874 <em>
875
876 <!-- TYPE -->
877 <div style="display:inline">
878 (
879 <span class="optional" style="display: none; ">optional</spa n>
880 <span id="typeTemplate">
881 <span style="display: none; ">
882 <a> Type</a>
883 </span>
884 <span>
885 <span style="display: none; ">
886 array of <span><span></span></span>
887 </span>
888 <span>string</span>
889 </span>
890 </span>
891 )
892 </div>
893
894 </em>
895 </dt>
896 <dd class="todo" style="display: none; ">
897 Undocumented.
898 </dd>
899 <dd>The html file to show in a popup. If set to the empty string ('') , no popup is shown.</dd>
900
901 <!-- OBJECT PROPERTIES -->
902 <dd style="display: none; ">
903 <dl>
904 <div>
905 <div>
906 </div>
907 </div>
908 </dl>
909 </dd>
910 </div>
911 </div>
912 </dl>
913 </dd>
914 </div>
915 </div>
916 </dl>
917
918 <!-- RETURNS -->
919 <h4 style="display: none; ">Returns</h4>
920 <dl>
921 <div style="display: none; ">
922 <div>
923 </div>
924 </div>
925 </dl>
926
927 <!-- CALLBACK -->
928 <div style="display: none; ">
929 <div>
930 <h4>Callback function</h4>
931 <p>
932 The callback <em>parameter</em> should specify a function
933 that looks like this:
934 </p>
935 <p>
936 If you specify the <em>callback</em> parameter, it should
937 specify a function that looks like this:
938 </p>
939
940 <!-- Note: intentionally longer 80 columns -->
941 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>);</pre>
942 <dl>
943 <div>
944 <div>
945 </div>
946 </div>
947 </dl>
948 </div>
949 </div>
950
951 </div> <!-- /description -->
952
953 </div><div class="apiItem">
776 <a name="method-setTitle"></a> <!-- method-anchor --> 954 <a name="method-setTitle"></a> <!-- method-anchor -->
777 <h4>setTitle</h4> 955 <h4>setTitle</h4>
778 956
779 <div class="summary"><span style="display: none; ">void</span> 957 <div class="summary"><span style="display: none; ">void</span>
780 <!-- Note: intentionally longer 80 columns --> 958 <!-- Note: intentionally longer 80 columns -->
781 <span>chrome.pageAction.setTitle</span>(<span class="null"><sp an style="display: none; ">, </span><span>object</span> 959 <span>chrome.pageAction.setTitle</span>(<span class="null"><sp an style="display: none; ">, </span><span>object</span>
782 <var><span>details</span></var></span>)</div> 960 <var><span>details</span></var></span>)</div>
783 961
784 <div class="description"> 962 <div class="description">
785 <p class="todo" style="display: none; ">Undocumented.</p> 963 <p class="todo" style="display: none; ">Undocumented.</p>
(...skipping 271 matching lines...) Expand 10 before | Expand all | Expand 10 after
1057 <a name="event-onClicked"></a> 1235 <a name="event-onClicked"></a>
1058 <h4>onClicked</h4> 1236 <h4>onClicked</h4>
1059 1237
1060 <div class="summary"> 1238 <div class="summary">
1061 <!-- Note: intentionally longer 80 columns --> 1239 <!-- Note: intentionally longer 80 columns -->
1062 <span class="subdued">chrome.pageAction.</span><span>onClicked</ span><span class="subdued">.addListener</span>(function(<span>Tab tab</span>) <s pan class="subdued">{...}</span>); 1240 <span class="subdued">chrome.pageAction.</span><span>onClicked</ span><span class="subdued">.addListener</span>(function(<span>Tab tab</span>) <s pan class="subdued">{...}</span>);
1063 </div> 1241 </div>
1064 1242
1065 <div class="description"> 1243 <div class="description">
1066 <p class="todo" style="display: none; ">Undocumented.</p> 1244 <p class="todo" style="display: none; ">Undocumented.</p>
1067 <p>Fired when a page action icon is clicked.</p> 1245 <p>Fired when a page action icon is clicked if the page action d oesn't show a popup.</p>
1068 1246
1069 <!-- PARAMETERS --> 1247 <!-- PARAMETERS -->
1070 <h4>Parameters</h4> 1248 <h4>Parameters</h4>
1071 <dl> 1249 <dl>
1072 <div> 1250 <div>
1073 <div> 1251 <div>
1074 <dt> 1252 <dt>
1075 <var>tab</var> 1253 <var>tab</var>
1076 <em> 1254 <em>
1077 1255
(...skipping 94 matching lines...) Expand 10 before | Expand all | Expand 10 after
1172 _uff=0; 1350 _uff=0;
1173 urchinTracker(); 1351 urchinTracker();
1174 } 1352 }
1175 catch(e) {/* urchinTracker not available. */} 1353 catch(e) {/* urchinTracker not available. */}
1176 </script> 1354 </script>
1177 <!-- end analytics --> 1355 <!-- end analytics -->
1178 </div> 1356 </div>
1179 </div> <!-- /gc-footer --> 1357 </div> <!-- /gc-footer -->
1180 </div> <!-- /gc-container --> 1358 </div> <!-- /gc-container -->
1181 </body></html> 1359 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/api/extension_api.json ('k') | chrome/common/extensions/docs/static/pageAction.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698