customizer.js 16.1 KB
Newer Older
1
/*!
2
 * Bootstrap Customizer (http://getbootstrap.com/customize/)
XhmikosR's avatar
XhmikosR committed
3
 * Copyright 2011-2015 Twitter, Inc.
4
5
6
 *
 * Licensed under the Creative Commons Attribution 3.0 Unported License. For
 * details, see http://creativecommons.org/licenses/by/3.0/.
7
8
 */

9
/* jshint es3:false */
10
/* global JSZip, less, autoprefixer, saveAs, UglifyJS, __configBridge, __js, __less, __fonts */
XhmikosR's avatar
XhmikosR committed
11

fat's avatar
fat committed
12
window.onload = function () { // wait for load in a dumb way because B-0
XhmikosR's avatar
XhmikosR committed
13
  'use strict';
XhmikosR's avatar
XhmikosR committed
14

15
  var cw = '/*!\n' +
Chris Rebert's avatar
Chris Rebert committed
16
           ' * Bootstrap v3.3.4 (http://getbootstrap.com)\n' +
17
           ' * Copyright 2011-' + new Date().getFullYear() + ' Twitter, Inc.\n' +
18
           ' * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)\n' +
19
           ' */\n\n'
fat's avatar
fat committed
20

XhmikosR's avatar
XhmikosR committed
21
  var supportsFile = window.File && window.FileReader && window.FileList && window.Blob
XhmikosR's avatar
XhmikosR committed
22
  var $importDropTarget = $('#import-drop-target')
23

fat's avatar
fat committed
24
  function showError(msg, err) {
25
26
    $('<div id="bsCustomizerAlert" class="bs-customizer-alert">' +
        '<div class="container">' +
27
28
          '<a href="#bsCustomizerAlert" data-dismiss="alert" class="close pull-right" aria-label="Close" role="button"><span aria-hidden="true">&times;</span></a>' +
          '<p class="bs-customizer-alert-text"><span class="glyphicon glyphicon-warning-sign" aria-hidden="true"></span><span class="sr-only">Warning:</span>' + msg + '</p>' +
29
30
          (err.message ? $('<p></p>').text('Error: ' + err.message)[0].outerHTML : '') +
          (err.extract ? $('<pre class="bs-customizer-alert-extract"></pre>').text(err.extract.join('\n'))[0].outerHTML : '') +
31
32
        '</div>' +
      '</div>').appendTo('body').alert()
fat's avatar
fat committed
33
34
35
    throw err
  }

36
  function showSuccess(msg) {
37
    $('<div class="bs-callout bs-callout-info">' +
38
      '<button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button>' + msg +
39
40
41
    '</div>').insertAfter('.bs-customize-download')
  }

fat's avatar
fat committed
42
  function showCallout(msg, showUpTop) {
XhmikosR's avatar
XhmikosR committed
43
    var $callout = $('<div class="bs-callout bs-callout-danger">' +
44
      '<h4>Attention!</h4>' +
45
46
      '<p>' + msg + '</p>' +
    '</div>')
fat's avatar
fat committed
47
48

    if (showUpTop) {
XhmikosR's avatar
XhmikosR committed
49
      $callout.appendTo('.bs-docs-container')
fat's avatar
fat committed
50
    } else {
XhmikosR's avatar
XhmikosR committed
51
      $callout.insertAfter('.bs-customize-download')
fat's avatar
fat committed
52
53
54
    }
  }

55
  function showAlert(type, msg, insertAfter) {
56
    $('<div class="alert alert-' + type + '">' + msg + '<button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button></div>')
57
58
59
      .insertAfter(insertAfter)
  }

fat's avatar
fat committed
60
  function getQueryParam(key) {
61
62
63
    key = key.replace(/[*+?^$.\[\]{}()|\\\/]/g, '\\$&') // escape RegEx meta chars
    var match = location.search.match(new RegExp('[?&]' + key + '=([^&]+)(&|$)'))
    return match && decodeURIComponent(match[1].replace(/\+/g, ' '))
fat's avatar
fat committed
64
65
  }

66
  function createGist(configJson, callback) {
fat's avatar
fat committed
67
    var data = {
XhmikosR's avatar
XhmikosR committed
68
      description: 'Bootstrap Customizer Config',
XhmikosR's avatar
XhmikosR committed
69
      'public': true,
XhmikosR's avatar
XhmikosR committed
70
      files: {
XhmikosR's avatar
XhmikosR committed
71
        'config.json': {
XhmikosR's avatar
XhmikosR committed
72
          content: configJson
fat's avatar
fat committed
73
74
75
76
77
78
        }
      }
    }
    $.ajax({
      url: 'https://api.github.com/gists',
      type: 'POST',
79
      contentType: 'application/json; charset=UTF-8',
fat's avatar
fat committed
80
81
82
      dataType: 'json',
      data: JSON.stringify(data)
    })
83
    .success(function (result) {
84
      var gistUrl = result.html_url;
XhmikosR's avatar
XhmikosR committed
85
      var origin = window.location.protocol + '//' + window.location.host
86
87
88
89
90
      var customizerUrl = origin + window.location.pathname + '?id=' + result.id
      showSuccess('<strong>Success!</strong> Your configuration has been saved to <a href="' + gistUrl + '">' + gistUrl + '</a> ' +
        'and can be revisited here at <a href="' + customizerUrl + '">' + customizerUrl + '</a> for further customization.')
      history.replaceState(false, document.title, customizerUrl)
      callback(gistUrl, customizerUrl)
fat's avatar
fat committed
91
    })
92
    .error(function (err) {
93
94
      try {
        showError('<strong>Ruh roh!</strong> Could not save gist file, configuration not saved.', err)
XhmikosR's avatar
XhmikosR committed
95
      } catch (sameErr) {
96
97
        // deliberately ignore the error
      }
98
      callback('<none>', '<none>')
fat's avatar
fat committed
99
100
101
    })
  }

fat's avatar
fat committed
102
  function getCustomizerData() {
fat's avatar
fat committed
103
104
105
    var vars = {}

    $('#less-variables-section input')
106
107
108
      .each(function () {
        $(this).val() && (vars[$(this).prev().text()] = $(this).val())
      })
fat's avatar
fat committed
109
110
111

    var data = {
      vars: vars,
fat's avatar
fat committed
112
113
      css: $('#less-section input:checked')  .map(function () { return this.value }).toArray(),
      js:  $('#plugin-section input:checked').map(function () { return this.value }).toArray()
fat's avatar
fat committed
114
115
    }

XhmikosR's avatar
XhmikosR committed
116
    if ($.isEmptyObject(data.vars) && !data.css.length && !data.js.length) return null
fat's avatar
fat committed
117

fat's avatar
fat committed
118
    return data
fat's avatar
fat committed
119
120
  }

121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
  function updateCustomizerFromJson(data) {
    if (data.js) {
      $('#plugin-section input').each(function () {
        $(this).prop('checked', ~$.inArray(this.value, data.js))
      })
    }
    if (data.css) {
      $('#less-section input').each(function () {
        $(this).prop('checked', ~$.inArray(this.value, data.css))
      })
    }
    if (data.vars) {
      for (var i in data.vars) {
        $('input[data-var="' + i + '"]').val(data.vars[i])
      }
    }
  }

fat's avatar
fat committed
139
  function parseUrl() {
fat's avatar
fat committed
140
    var id = getQueryParam('id')
fat's avatar
fat committed
141

fat's avatar
fat committed
142
    if (!id) return
fat's avatar
fat committed
143

fat's avatar
fat committed
144
145
146
147
148
    $.ajax({
      url: 'https://api.github.com/gists/' + id,
      type: 'GET',
      dataType: 'json'
    })
149
    .success(function (result) {
fat's avatar
fat committed
150
      var data = JSON.parse(result.files['config.json'].content)
151
      updateCustomizerFromJson(data)
fat's avatar
fat committed
152
    })
153
    .error(function (err) {
fat's avatar
fat committed
154
      showError('Error fetching bootstrap config file', err)
fat's avatar
fat committed
155
    })
fat's avatar
fat committed
156
157
  }

158
  function generateZip(css, js, fonts, config, complete) {
159
    if (!css && !js) return showError('<strong>Ruh roh!</strong> No Bootstrap files selected.', new Error('no Bootstrap'))
fat's avatar
fat committed
160
161
162
163
164
165
166
167
168
169
170
171

    var zip = new JSZip()

    if (css) {
      var cssFolder = zip.folder('css')
      for (var fileName in css) {
        cssFolder.file(fileName, css[fileName])
      }
    }

    if (js) {
      var jsFolder = zip.folder('js')
172
173
      for (var jsFileName in js) {
        jsFolder.file(jsFileName, js[jsFileName])
fat's avatar
fat committed
174
175
176
      }
    }

fat's avatar
fat committed
177
178
    if (fonts) {
      var fontsFolder = zip.folder('fonts')
179
      for (var fontsFileName in fonts) {
XhmikosR's avatar
XhmikosR committed
180
        fontsFolder.file(fontsFileName, fonts[fontsFileName], { base64: true })
fat's avatar
fat committed
181
182
183
      }
    }

184
    if (config) {
XhmikosR's avatar
XhmikosR committed
185
      zip.file('config.json', config)
186
187
    }

XhmikosR's avatar
XhmikosR committed
188
    var content = zip.generate({ type: 'blob' })
fat's avatar
fat committed
189
190

    complete(content)
fat's avatar
fat committed
191
192
  }

193
  function generateCustomLess(vars) {
fat's avatar
fat committed
194
195
196
197
198
199
200
201
202
    var result = ''

    for (var key in vars) {
      result += key + ': ' + vars[key] + ';\n'
    }

    return result + '\n\n'
  }

fat's avatar
fat committed
203
  function generateFonts() {
XhmikosR's avatar
XhmikosR committed
204
205
    var $glyphicons = $('#less-section [value="glyphicons.less"]:checked')
    if ($glyphicons.length) {
fat's avatar
fat committed
206
207
208
209
      return __fonts
    }
  }

210
  // Returns an Array of @import'd filenames in the order
211
  // in which they appear in the file.
212
  function includedLessFilenames(lessFilename) {
213
    var IMPORT_REGEX = /^@import \"(.*?)\";$/
214
    var lessLines = __less[lessFilename].split('\n')
215

216
217
218
219
220
221
222
223
224
225
226
227
228
229
    var imports = []
    $.each(lessLines, function (index, lessLine) {
      var match = IMPORT_REGEX.exec(lessLine)
      if (match) {
        var importee = match[1]
        var transitiveImports = includedLessFilenames(importee)
        $.each(transitiveImports, function (index, transitiveImportee) {
          if ($.inArray(transitiveImportee, imports) === -1) {
            imports.push(transitiveImportee)
          }
        })
        imports.push(importee)
      }
    })
230
231
232
233

    return imports
  }

234
235
236
  function generateLESS(lessFilename, lessFileIncludes, vars) {
    var lessSource = __less[lessFilename]

237
    var lessFilenames = includedLessFilenames(lessFilename)
XhmikosR's avatar
XhmikosR committed
238
    $.each(lessFilenames, function (index, filename) {
239
240
241
242
243
244
      var fileInclude = lessFileIncludes[filename]

      // Files not explicitly unchecked are compiled into the final stylesheet.
      // Core stylesheets like 'normalize.less' are not included in the form
      // since disabling them would wreck everything, and so their 'fileInclude'
      // will be 'undefined'.
XhmikosR's avatar
XhmikosR committed
245
      if (fileInclude || fileInclude == null)    lessSource += __less[filename]
246
247
248

      // Custom variables are added after Bootstrap variables so the custom
      // ones take precedence.
XhmikosR's avatar
XhmikosR committed
249
      if (filename === 'variables.less' && vars) lessSource += generateCustomLess(vars)
250
251
    })

252
    lessSource = lessSource.replace(/@import[^\n]*/gi, '') // strip any imports
253
254
255
256
    return lessSource
  }

  function compileLESS(lessSource, baseFilename, intoResult) {
257
    var promise = $.Deferred()
258
    var parser = new less.Parser({
259
260
261
      paths: ['variables.less', 'mixins.less'],
      optimization: 0,
      filename: baseFilename + '.css'
XhmikosR's avatar
XhmikosR committed
262
263
    })

264
265
266
267
268
269
270
    parser.parse(lessSource, function (parseErr, tree) {
      if (parseErr) {
        return promise.reject(parseErr)
      }
      try {
        intoResult[baseFilename + '.css']     = cw + tree.toCSS()
        intoResult[baseFilename + '.min.css'] = cw + tree.toCSS({ compress: true })
XhmikosR's avatar
XhmikosR committed
271
      } catch (compileErr) {
272
        return promise.reject(compileErr)
273
      }
274
      promise.resolve()
275
    })
276
277

    return promise.promise()
278
279
  }

280
  function generateCSS(preamble) {
281
    var promise = $.Deferred()
282
283
    var oneChecked = false
    var lessFileIncludes = {}
XhmikosR's avatar
XhmikosR committed
284
    $('#less-section input').each(function () {
285
286
287
288
289
290
      var $this = $(this)
      var checked = $this.is(':checked')
      lessFileIncludes[$this.val()] = checked

      oneChecked = oneChecked || checked
    })
fat's avatar
fat committed
291

292
    if (!oneChecked) return false
fat's avatar
fat committed
293
294
295
296
297

    var result = {}
    var vars = {}

    $('#less-variables-section input')
298
299
300
      .each(function () {
        $(this).val() && (vars[$(this).prev().text()] = $(this).val())
      })
fat's avatar
fat committed
301

302
303
    var bsLessSource    = preamble + generateLESS('bootstrap.less', lessFileIncludes, vars)
    var themeLessSource = preamble + generateLESS('theme.less',     lessFileIncludes, vars)
fat's avatar
fat committed
304

305
306
307
308
    var prefixer = autoprefixer({ browsers: __configBridge.autoprefixerBrowsers })

    $.when(
      compileLESS(bsLessSource, 'bootstrap', result),
309
      compileLESS(themeLessSource, 'bootstrap-theme', result)
310
311
312
313
314
315
    ).done(function () {
      for (var key in result) {
        result[key] = prefixer.process(result[key]).css
      }
      promise.resolve(result)
    }).fail(function (err) {
316
      showError('<strong>Ruh roh!</strong> Problem parsing or compiling Less files.', err)
317
318
      promise.reject()
    })
fat's avatar
fat committed
319

320
    return promise.promise()
fat's avatar
fat committed
321
322
  }

323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
  function uglify(js) {
    var ast = UglifyJS.parse(js)
    ast.figure_out_scope()

    var compressor = UglifyJS.Compressor()
    var compressedAst = ast.transform(compressor)

    compressedAst.figure_out_scope()
    compressedAst.compute_char_frequency()
    compressedAst.mangle_names()

    var stream = UglifyJS.OutputStream()
    compressedAst.print(stream)

    return stream.toString()
  }

  function generateJS(preamble) {
fat's avatar
fat committed
341
    var $checked = $('#plugin-section input:checked')
342
343
    var jqueryCheck = __configBridge.jqueryCheck.join('\n')
    var jqueryVersionCheck = __configBridge.jqueryVersionCheck.join('\n')
344

fat's avatar
fat committed
345
346
347
348
349
350
351
    if (!$checked.length) return false

    var js = $checked
      .map(function () { return __js[this.value] })
      .toArray()
      .join('\n')

352
    preamble = cw + preamble
353
    js = jqueryCheck + jqueryVersionCheck + js
354

fat's avatar
fat committed
355
    return {
356
      'bootstrap.js': preamble + js,
357
      'bootstrap.min.js': preamble + uglify(js)
fat's avatar
fat committed
358
359
360
    }
  }

361
  function removeImportAlerts() {
XhmikosR's avatar
XhmikosR committed
362
    $importDropTarget.nextAll('.alert').remove()
363
364
365
366
367
368
  }

  function handleConfigFileSelect(e) {
    e.stopPropagation()
    e.preventDefault()

XhmikosR's avatar
XhmikosR committed
369
    var file = e.originalEvent.hasOwnProperty('dataTransfer') ? e.originalEvent.dataTransfer.files[0] : e.originalEvent.target.files[0]
370
371
372

    var reader = new FileReader()

373
374
    reader.onload = function (e) {
      var text = e.target.result
375

376
377
      try {
        var json = JSON.parse(text)
378

379
380
        if (!$.isPlainObject(json)) {
          throw new Error('JSON data from config file is not an object.')
381
        }
382
383

        updateCustomizerFromJson(json)
XhmikosR's avatar
XhmikosR committed
384
        showAlert('success', '<strong>Woohoo!</strong> Your configuration was successfully uploaded. Tweak your settings, then hit Download.', $importDropTarget)
385
      } catch (err) {
XhmikosR's avatar
XhmikosR committed
386
        return showAlert('danger', '<strong>Shucks.</strong> We can only read valid <code>.json</code> files. Please try again.', $importDropTarget)
387
      }
388
    }
389

390
    reader.readAsText(file, 'utf-8')
391
392
393
394
395
396
397
398
399
400
401
  }

  function handleConfigDragOver(e) {
    e.stopPropagation()
    e.preventDefault()
    e.originalEvent.dataTransfer.dropEffect = 'copy'

    removeImportAlerts()
  }

  if (supportsFile) {
XhmikosR's avatar
XhmikosR committed
402
    $importDropTarget
403
404
405
406
      .on('dragover', handleConfigDragOver)
      .on('drop', handleConfigFileSelect)
  }

407
  $('#import-file-select').on('change', handleConfigFileSelect)
408
409
  $('#import-manual-trigger').on('click', removeImportAlerts)

XhmikosR's avatar
XhmikosR committed
410
411
412
  var $inputsComponent = $('#less-section input')
  var $inputsPlugin    = $('#plugin-section input')
  var $inputsVariables = $('#less-variables-section input')
fat's avatar
fat committed
413
414
415

  $('#less-section .toggle').on('click', function (e) {
    e.preventDefault()
XhmikosR's avatar
XhmikosR committed
416
    $inputsComponent.prop('checked', !$inputsComponent.is(':checked'))
fat's avatar
fat committed
417
418
419
420
  })

  $('#plugin-section .toggle').on('click', function (e) {
    e.preventDefault()
XhmikosR's avatar
XhmikosR committed
421
    $inputsPlugin.prop('checked', !$inputsPlugin.is(':checked'))
fat's avatar
fat committed
422
423
424
425
  })

  $('#less-variables-section .toggle').on('click', function (e) {
    e.preventDefault()
XhmikosR's avatar
XhmikosR committed
426
    $inputsVariables.val('')
fat's avatar
fat committed
427
428
  })

fat's avatar
fat committed
429
430
431
432
433
434
  $('[data-dependencies]').on('click', function () {
    if (!$(this).is(':checked')) return
    var dependencies = this.getAttribute('data-dependencies')
    if (!dependencies) return
    dependencies = dependencies.split(',')
    for (var i = 0; i < dependencies.length; i++) {
XhmikosR's avatar
XhmikosR committed
435
436
      var $dependency = $('[value="' + dependencies[i] + '"]')
      $dependency && $dependency.prop('checked', true)
fat's avatar
fat committed
437
438
439
440
441
442
443
444
445
    }
  })

  $('[data-dependents]').on('click', function () {
    if ($(this).is(':checked')) return
    var dependents = this.getAttribute('data-dependents')
    if (!dependents) return
    dependents = dependents.split(',')
    for (var i = 0; i < dependents.length; i++) {
XhmikosR's avatar
XhmikosR committed
446
447
      var $dependent = $('[value="' + dependents[i] + '"]')
      $dependent && $dependent.prop('checked', false)
fat's avatar
fat committed
448
449
450
    }
  })

fat's avatar
fat committed
451
452
453
  var $compileBtn = $('#btn-compile')

  $compileBtn.on('click', function (e) {
454
455
456
    var configData = getCustomizerData()
    var configJson = JSON.stringify(configData, null, 2)

fat's avatar
fat committed
457
458
459
460
    e.preventDefault()

    $compileBtn.attr('disabled', 'disabled')

461
462
463
464
465
466
467
468
469
    createGist(configJson, function (gistUrl, customizerUrl) {
      configData.customizerUrl = customizerUrl
      configJson = JSON.stringify(configData, null, 2)

      var preamble = '/*!\n' +
        ' * Generated using the Bootstrap Customizer (' + customizerUrl + ')\n' +
        ' * Config saved to config.json and ' + gistUrl + '\n' +
        ' */\n'

470
471
472
473
474
475
476
      $.when(
        generateCSS(preamble),
        generateJS(preamble),
        generateFonts()
      ).done(function (css, js, fonts) {
        generateZip(css, js, fonts, configJson, function (blob) {
          $compileBtn.removeAttr('disabled')
XhmikosR's avatar
XhmikosR committed
477
478
479
          setTimeout(function () {
            saveAs(blob, 'bootstrap.zip')
          }, 0)
480
        })
481
      })
fat's avatar
fat committed
482
    })
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
  });

  // browser support alert
  (function () {
    function failback() {
      $('.bs-docs-section, .bs-docs-sidebar').css('display', 'none')
      showCallout('Looks like your current browser doesn\'t support the Bootstrap Customizer. Please take a second ' +
                    'to <a href="http://browsehappy.com/">upgrade to a more modern browser</a> (other than Safari).', true)
    }
    /**
     * Based on:
     *   Blob Feature Check v1.1.0
     *   https://github.com/ssorallen/blob-feature-check/
     *   License: Public domain (http://unlicense.org)
     */
    var url = window.webkitURL || window.URL // Safari 6 uses "webkitURL".
    var svg = new Blob(
      ['<svg xmlns=\'http://www.w3.org/2000/svg\'></svg>'],
XhmikosR's avatar
XhmikosR committed
501
      { type: 'image/svg+xml;charset=utf-8' }
502
503
    )
    var objectUrl = url.createObjectURL(svg);
504
505

    if (/^blob:/.exec(objectUrl) === null || !supportsFile) {
506
507
508
509
      // `URL.createObjectURL` created a URL that started with something other
      // than "blob:", which means it has been polyfilled and is not supported by
      // this browser.
      failback()
XhmikosR's avatar
XhmikosR committed
510
    } else {
511
512
513
514
515
516
517
518
      $('<img>')
        .on('load', function () {
          $compileBtn.prop('disabled', false)
        })
        .on('error', failback)
        .attr('src', objectUrl)
    }
  })();
fat's avatar
fat committed
519

fat's avatar
fat committed
520
  parseUrl()
521
}