JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.6.3
[ckeditor.git] / _samples / autogrow.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
2 <!--\r
3 Copyright (c) 2003-2012, CKSource - Frederico Knabben. All rights reserved.\r
4 For licensing, see LICENSE.html or http://ckeditor.com/license\r
5 -->\r
6 <html xmlns="http://www.w3.org/1999/xhtml">\r
7 <head>\r
8         <title>AutoGrow Plugin &mdash; CKEditor Sample</title>\r
9         <meta content="text/html; charset=utf-8" http-equiv="content-type" />\r
10         <script type="text/javascript" src="../ckeditor.js"></script>\r
11         <script src="sample.js" type="text/javascript"></script>\r
12         <link href="sample.css" rel="stylesheet" type="text/css" />\r
13 </head>\r
14 <body>\r
15         <h1 class="samples">\r
16                 CKEditor Sample &mdash; Using AutoGrow Plugin\r
17         </h1>\r
18         <div class="description">\r
19         <p>\r
20                 This sample shows how to configure CKEditor instances to use the\r
21                 <strong>AutoGrow</strong> (<code>autogrow</code>) plugin that lets the editor window expand\r
22                 and shrink depending on the amount and size of content entered in the editing area.\r
23         </p>\r
24         <p>\r
25                 In its default implementation the <strong>AutoGrow feature</strong> can expand the\r
26                 CKEditor window infinitely in order to avoid introducing scrollbars to the editing area.\r
27         </p>\r
28         <p>\r
29                 It is also possible to set a maximum height for the editor window. Once CKEditor\r
30                 editing area reaches the value in pixels specified in the <code>\r
31                 <a href="http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.autoGrow_maxHeight">autoGrow_maxHeight</a>\r
32                 </code> configuration setting, scrollbars will be added and the editor window will no longer expand.\r
33         </p>\r
34         <p>\r
35                 To add a CKEditor instance using the <code>autogrow</code> plugin and its\r
36                 <code>autoGrow_maxHeight</code> attribute, insert the following JavaScript call to your code:\r
37         </p>\r
38         <pre class="samples">CKEDITOR.replace( '<em>textarea_id</em>',\r
39         {\r
40                 <strong>extraPlugins : 'autogrow',</strong>\r
41                 autoGrow_maxHeight : 800,\r
42                 // Remove the Resize plugin as it does not make sense to use it in conjunction with the AutoGrow plugin.\r
43                 removePlugins : 'resize'\r
44         });</pre>\r
45         <p>\r
46                 Note that <code><em>textarea_id</em></code> in the code above is the <code>id</code> attribute of\r
47                 the <code>&lt;textarea&gt;</code> element to be replaced with CKEditor. The maximum height should\r
48                 be given in pixels.\r
49         </p>\r
50         </div>\r
51         <!-- This <div> holds alert messages to be display in the sample page. -->\r
52         <div id="alerts">\r
53                 <noscript>\r
54                         <p>\r
55                                 <strong>CKEditor requires JavaScript to run</strong>. In a browser with no JavaScript\r
56                                 support, like yours, you should still see the contents (HTML data) and you should\r
57                                 be able to edit it normally, without a rich editor interface.\r
58                         </p>\r
59                 </noscript>\r
60         </div>\r
61         <form action="sample_posteddata.php" method="post">\r
62                 <p>\r
63                         <label for="editor1">\r
64                                 CKEditor using the <code>autogrow</code> plugin with its default configuration:</label>\r
65                         <textarea cols="80" id="editor1" name="editor1" rows="10">&lt;p&gt;This is some &lt;strong&gt;sample text&lt;/strong&gt;. You are using &lt;a href="http://ckeditor.com/"&gt;CKEditor&lt;/a&gt;.&lt;/p&gt;</textarea>\r
66                         <script type="text/javascript">\r
67                         //<![CDATA[\r
68 \r
69                                 CKEDITOR.replace( 'editor1', {\r
70                                         extraPlugins : 'autogrow',\r
71                                         removePlugins : 'resize'\r
72                                 });\r
73 \r
74                         //]]>\r
75                         </script>\r
76                 </p>\r
77                 <p>\r
78                         <label for="editor2">\r
79                                 CKEditor using the <code>autogrow</code> plugin with maximum height set to 400 pixels:</label>\r
80                         <textarea cols="80" id="editor2" name="editor2" rows="10">&lt;p&gt;This is some &lt;strong&gt;sample text&lt;/strong&gt;. You are using &lt;a href="http://ckeditor.com/"&gt;CKEditor&lt;/a&gt;.&lt;/p&gt;</textarea>\r
81                         <script type="text/javascript">\r
82                         //<![CDATA[\r
83 \r
84                                 CKEDITOR.replace( 'editor2', {\r
85                                         extraPlugins : 'autogrow',\r
86                                         autoGrow_maxHeight : 400,\r
87                                         removePlugins : 'resize'\r
88                                 });\r
89 \r
90                         //]]>\r
91                         </script>\r
92                 </p>\r
93                 <p>\r
94                         <input type="submit" value="Submit" />\r
95                 </p>\r
96         </form>\r
97         <div id="footer">\r
98                 <hr />\r
99                 <p>\r
100                         CKEditor - The text editor for the Internet - <a class="samples" href="http://ckeditor.com/">http://ckeditor.com</a>\r
101                 </p>\r
102                 <p id="copy">\r
103                         Copyright &copy; 2003-2012, <a class="samples" href="http://cksource.com/">CKSource</a> - Frederico\r
104                         Knabben. All rights reserved.\r
105                 </p>\r
106         </div>\r
107 </body>\r
108 </html>\r