bootstrap-js.html 13.6 KB
Newer Older
Jacob Thornton's avatar
Jacob Thornton committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Bootstrap, from Twitter</title>
    <meta name="description" content="">
    <meta name="author" content="">

    <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
    <!--[if lt IE 9]>
      <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->

    <!-- Le javascript -->
    <script src="http://code.jquery.com/jquery-1.5.2.min.js"></script>
16
17
18
    <script src="assets/js/bootstrap-modal.js"></script>
    <script src="assets/js/bootstrap-alerts.js"></script>
    <script src="assets/js/bootstrap-twipsy.js"></script>
Jacob Thornton's avatar
Jacob Thornton committed
19
20
    <script src="assets/js/bootstrap-popover.js"></script>
    <!-- <script src="assets/js/bootstrap-dropdown.js"></script> -->
Jacob Thornton's avatar
Jacob Thornton committed
21
22
23
24
25
26
27
28
29
30
31

    <!-- Le styles -->
    <link href="../bootstrap-1.1.1.css" rel="stylesheet">

    <!-- Le fav and touch icons -->
    <link rel="shortcut icon" href="images/favicon.ico">
    <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
    <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
  </head>

32
  <body style="padding: 60px 0">
Jacob Thornton's avatar
Jacob Thornton committed
33
34
35
36
37
38
39
40

    <!-- Topbar
    ================================================== -->
    <div class="topbar">
      <div class="fill">
        <div class="container">
          <h3><a href="#">Bootstrap JS</a></h3>
          <ul>
41
            <li class="active"><a href="#javascript">Getting Started</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
42
            <li><a href="#modal">Modals</a></li>
43
44
            <li><a href="#alerts">Alerts</a></li>
            <li><a href="#twipsy">Twipsy</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
45
            <li><a href="#popover">Popover</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
46
47
48
49
50
51
52
53
54
55
56
57
          </ul>
        </div>
      </div>
    </div>

    <div class="container">

    <!-- Using Javascript w/ Bootstrap
    ================================================== -->

    <section id="javascript">
      <div class="page-header">
Jacob Thornton's avatar
Jacob Thornton committed
58
        <h1>Using Javascript with Bootstrap <small>A love story.</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
59
60
61
62
63
64
      </div>
      <div class="row">
        <div class="span4 columns">
          <p>This page illustrates how to integrate javascript with the Bootstrap library. Below we go over the basics and provide you with some awesome plugins to get you started!</p>
        </div>
        <div class="span12 columns">
Jacob Thornton's avatar
Jacob Thornton committed
65
          <h2>What is this all about?</h2>
Jacob Thornton's avatar
Jacob Thornton committed
66
67
68
69
70
71
72
73
74
75
76
77
          <p>With this example page, we've set out to make your interactive work with Bootstrap even more simple, offering several lightweight plugins for things like modals, tooltips, and other dynamic components. These plugins have been coded up to work with <a href="http://jquery.com/" target="_blank">jQuery</a> and <a href="http://ender.no.de" target="_blank">Ender</a>, but we encourage you to extend and modify them to fit your development needs!</p>
          <h2>Do I need these?</h2>
          <p>The short answer is <strong>NO!</strong> These plugins were provided to help you understand how to integrate bootstrap with javascript and to give you a quick lightweight option for dropping something in and getting the basic functionality.
          </p>
        </div>
      </div>
    </section>


    <!-- Modal
    ================================================== -->

78
    <section id="modal">
Jacob Thornton's avatar
Jacob Thornton committed
79
      <div class="page-header">
80
        <h1>Modals <small>bootstrap-modal.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
81
82
83
84
      </div>
      <div class="row">
        <div class="span4 columns">
          <p>Our Modal plugin is <strong>super</strong> slim! We took special care to only include the bare functionality that we require at twitter, however we look forward to seeing all the cool stuff you do with it!</p>
85
          <a href="assets/js/bootstrap-modal.js" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
86
87
88
        </div>
        <div class="span12 columns">
          <h2>Using bootstrap-modal</h2>
89
          <pre class="prettyprint linenums">$('#modal-content').modal(options)</pre>
Jacob Thornton's avatar
Jacob Thornton committed
90
91
92
93
94
95
96
97
98
99
100
101
          <h3>Options</h3>
          <ul>
            <li><strong>backdrop</strong> (<code>boolean</code>) - if true, it will include a modal-backdrop element.</li>
            <li><strong>closeOnEscape</strong> (<code>boolean</code>) - if true, it will close the modal when escape key is pressed.</li>
            <li><strong>content</strong> (<code>string</code>) - alternative way of supplying modal class with HTML content.</li>
          </ul>
          <h3>Methods</h3>
          <h4>$().modal</h4>
          <p>Returns an instance of the modal class. Accepts an optional options <code>object</code>.</p>
<pre class="prettyprint linenums">
$('#modal-content').modal({
  closeOnEscape: true
102
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
103
104
105
106
107
108
109
110
111
112
113
114
          <h4>.toggle</h4>
          <p>Returns an instance of the modal class. Toggle the modal open state.</p>
          <pre class="prettyprint linenums">$('#modal-content').modal().toggle()</pre>
          <h4>.open</h4>
          <p>Returns an instance of the modal class. Opens the modal.</p>
          <pre class="prettyprint linenums">$('#modal-content').modal().open()</pre>
          <h4>.close</h4>
          <p>Returns an instance of the modal class. Closes the modal.</p>
          <pre class="prettyprint linenums">$('#modal-content').modal().close()</pre>
          <h3>Demo</h3>

          <!-- sample modal content -->
115
          <div id="modal-from-dom" class="modal hide">
Jacob Thornton's avatar
Jacob Thornton committed
116
117
118
119
120
121
122
123
124
125
126
127
128
            <div class="modal-header">
              <h3>Modal Heading</h3>
              <a href="#" class="close">&times;</a>
            </div>
            <div class="modal-body">
              <p>One fine body…</p>
            </div>
            <div class="modal-footer">
              <a href="#" class="btn primary">Primary</a>
              <a href="#" class="btn secondary">Secondary</a>
            </div>
          </div>

129
          <button id="modal-from-element" class="btn">Launch Modal</button>
Jacob Thornton's avatar
Jacob Thornton committed
130
131
132

          <script>
            $(function () {
133
134
135
136
              var domModal = $("#modal-from-dom").modal({
                backdrop: true
              , closeOnEscape: true
              })
Jacob Thornton's avatar
Jacob Thornton committed
137
138

              $('#modal-from-element').click(function () {
139
                domModal.toggle()
Jacob Thornton's avatar
Jacob Thornton committed
140
141
142
143
144
145
146
147
              })

            })
          </script>

        </div>
      </div>
    </section>
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218

    <!-- Alerts
    ================================================== -->

    <section id="alerts">
      <div class="page-header">
        <h1>Alerts <small>bootstrap-alerts.js</small></h1>
      </div>
      <div class="row">
        <div class="span4 columns">
          <p>The alert plugin is a super tiny class for adding close functionality to alerts.</p>
          <a href="assets/js/bootstrap-alerts.js" class="btn primary">Download</a>
        </div>
        <div class="span12 columns">
          <h2>Using bootstrap-alert</h2>
          <pre class="prettyprint linenums">$(".alert-message").alert()</pre>
          <h3>Methods</h3>
          <h4>$().alert</h4>
          <p>Wraps all alerts with close functionality.</p>
          <h3>Demo</h3>
          <div class="alert-message show warning">
            <a class="close" href="#">&times;</a>
            <p><strong>Holy guacamole!</strong> Best check yo self, you’re not looking too good.</p>
          </div>
          <div class="alert-message show block-message error">
            <a class="close" href="#">&times;</a>
            <p><strong>Oh snap! You got an error!</strong> Change this and that and try again. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum.</p>
            <div class="alert-actions">
              <a class="btn small" href="#">Take this action</a> <a class="btn small" href="#">Or do this</a>
            </div>
          </div>
          <script>
            $(function () {
              $(".alert-message").alert()
            })
          </script>
        </div>
      </div>
    </section>

    <!-- Tips
    ================================================== -->

    <section id="twipsy">
      <div class="page-header">
        <h1>Twipsy <small>bootstrap-twipsy.js</small></h1>
      </div>
      <div class="row">
        <div class="span4 columns">
          <p>Based on the excellent jQuery.tipsy plugin written by Jason Frame; twipsy is an updated version, which doesn't rely on images, uses css3 for animations, and data-attributes for title storage!</p>
          <a href="assets/js/bootstrap-twipsy.js" class="btn primary">Download</a>
        </div>
        <div class="span12 columns">
          <h2>Using bootstrap-twipsy.js</h2>
          <pre class="prettyprint linenums">$('#example').twipsy(options)</pre>
          <h3>Options</h3>
          <ul>
            <li><strong>delayIn</strong> (<code>number</code>) - delay before showing tooltip (ms).</li>
            <li><strong>delayOut</strong> (<code>number</code>) - delay before hiding tooltip (ms).</li>
            <li><strong>fallback</strong> (<code>string</code>) - fallback text to use when no tooltip text.</li>
            <li><strong>placement</strong> (<code>string</code>) - position of tooltip - above | below | left | right.</li>
            <li><strong>html</strong> (<code>boolean</code>) - is tooltip content HTML?</li>
            <li><strong>live</strong> (<code>boolean</code>) - use live event support?</li>
            <li><strong>offset</strong> (<code>number</code>) - pixel offset of tooltip from element.</li>
            <li><strong>title</strong> (<code>string|function</code>) - attribute/callback containing tooltip text.</li>
            <li><strong>trigger</strong> (<code>string</code>) - how tooltip is triggered - hover | focus | manual.</li>
          </ul>
          <h3>Methods</h3>
          <h4>$().twipsy</h4>
          <p>Attaches a twipsy handler to an element collection.</p>
          <h3>Demo</h3>
Jacob Thornton's avatar
Jacob Thornton committed
219
220
221
222
          <div class="well">
            <p class="muted">Tight pants next level keffiyeh <a href="#" rel='twipsy' title='Some title text'>you probably</a> haven't heard of them. Photo booth beard raw denim letterpress vegan messenger bag stumptown. Farm-to-table seitan, mcsweeney's fixie sustainable quinoa 8-bit american apparel <a href="#" rel='twipsy' title='Another twipsy'>have a</a> terry richardson vinyl chambray. Beard stumptown, cardigans banh mi lomo thundercats. Tofu biodiesel williamsburg marfa, four loko mcsweeney's cleanse vegan chambray. A <a href="#" rel='twipsy' title='Another one here too'>really ironic</a> artisan whatever keytar, scenester farm-to-table banksy Austin <a href="#" rel='twipsy' title='The last tip!'>twitter handle</a> freegan cred raw denim single-origin coffee viral.
            </p>
          </div>
223
224
225
226
227
228
229
230
231
232
233
          <script>
            $(function () {
              $("a[rel=twipsy]").twipsy({
                live: true
              })
            })
          </script>
        </div>
      </div>
    </section>

Jacob Thornton's avatar
Jacob Thornton committed
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
    <!-- Popovers
    ================================================== -->

    <section id="popover">
      <div class="page-header">
        <h1>Popovers <small>bootstrap-popover.js</small></h1>
      </div>
      <div class="row">
        <div class="span4 columns">
          <p>The popover plugin provides a simple interface for adding popovers to your application. It extends the <a href="#twipsy">boostrap-twipsy.js</a> plugin, so be sure to grab that file as well when including popovers in your project!</p>
          <a href="assets/js/bootstrap-popover.js" class="btn primary">Download</a>
        </div>
        <div class="span12 columns">
          <h2>Using boostrap-popover.js</h2>
          <pre class="prettyprint linenums">$('#example').popover(options)</pre>
          <h3>Options</h3>
          <ul>
            <li><strong>delayIn</strong> (<code>number</code>) - delay before showing tooltip (ms).</li>
            <li><strong>delayOut</strong> (<code>number</code>) - delay before hiding tooltip (ms).</li>
            <li><strong>fallback</strong> (<code>string</code>) - fallback text to use when no tooltip text.</li>
            <li><strong>placement</strong> (<code>string</code>) - position of tooltip - above | below | left | right.</li>
            <li><strong>html</strong> (<code>boolean</code>) - is tooltip content HTML?</li>
            <li><strong>live</strong> (<code>boolean</code>) - use live event support?</li>
            <li><strong>offset</strong> (<code>number</code>) - pixel offset of tooltip from element.</li>
            <li><strong>title</strong> (<code>string|function</code>) - text for title in popover. Alternatively you can specify a <code>data-title</code> attribute.</li>
            <li><strong>content</strong> (<code>string|function</code>) - text for content in popover. Also you can specify a <code>data-content</code> attibute.</li>
            <li><strong>trigger</strong> (<code>string</code>) - how tooltip is triggered - hover | focus | manual.</li>
          </ul>
          <h3>Methods</h3>
          <h4>$().popover</h4>
          <p>Initializes popovers for an element collection.</p>
          <h3>Demo</h3>
          <a href="#" class="btn" rel="popover" data-title="A Title" data-content="And here's some amazing content. It's very engaging. right?">hover</a>
          <script>
            $(function () {
              $("a[rel=popover]").popover({
                offset: 10
              })
            })
          </script>
        </div>
      </div>
    </section>
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296

    <!-- Section
    ================================================== -->

    <!--
    <section id="section">
      <div class="page-header">
        <h1></h1>
      </div>
      <div class="row">
        <div class="span4 columns">
          <p></p>
        </div>
        <div class="span12 columns">
          <h3></h3>
          <p></p>
        </div>
      </div>
    </section>
    -->
Jacob Thornton's avatar
Jacob Thornton committed
297
298
299
    </div>
  </body>
</html>