customizer.js 15.6 KB
Newer Older
1
/*!
2
 * Bootstrap Customizer (http://getbootstrap.com/customize/)
3
 * Copyright 2011-2014 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
/* global JSZip, less, autoprefixer, saveAs, UglifyJS, __configBridge, __js, __less, __fonts */
XhmikosR's avatar
XhmikosR committed
10

fat's avatar
fat committed
11
window.onload = function () { // wait for load in a dumb way because B-0
XhmikosR's avatar
XhmikosR committed
12
  'use strict';
13
  var cw = '/*!\n' +
Mark Otto's avatar
Mark Otto committed
14
           ' * Bootstrap v3.3.0 (http://getbootstrap.com)\n' +
15
           ' * Copyright 2011-' + new Date().getFullYear() + ' Twitter, Inc.\n' +
16
           ' * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)\n' +
17
           ' */\n\n'
fat's avatar
fat committed
18

19
20
21
  var supportsFile = (window.File && window.FileReader && window.FileList && window.Blob)
  var importDropTarget = $('#import-drop-target')

fat's avatar
fat committed
22
  function showError(msg, err) {
23
24
25
26
27
28
29
    $('<div id="bsCustomizerAlert" class="bs-customizer-alert">' +
        '<div class="container">' +
          '<a href="#bsCustomizerAlert" data-dismiss="alert" class="close pull-right">&times;</a>' +
          '<p class="bs-customizer-alert-text"><span class="glyphicon glyphicon-warning-sign"></span>' + msg + '</p>' +
          (err.extract ? '<pre class="bs-customizer-alert-extract">' + err.extract.join('\n') + '</pre>' : '') +
        '</div>' +
      '</div>').appendTo('body').alert()
fat's avatar
fat committed
30
31
32
    throw err
  }

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

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

    if (showUpTop) {
      callout.appendTo('.bs-docs-container')
    } else {
      callout.insertAfter('.bs-customize-download')
    }
  }

52
53
54
55
56
  function showAlert(type, msg, insertAfter) {
    $('<div class="alert alert-' + type + '">' + msg + '<button type="button" class="close" data-dismiss="alert" aria-hidden="true">&times;</button></div>')
      .insertAfter(insertAfter)
  }

fat's avatar
fat committed
57
  function getQueryParam(key) {
58
59
60
    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
61
62
  }

63
  function createGist(configJson, callback) {
fat's avatar
fat committed
64
    var data = {
XhmikosR's avatar
XhmikosR committed
65
      description: 'Bootstrap Customizer Config',
XhmikosR's avatar
XhmikosR committed
66
      'public': true,
XhmikosR's avatar
XhmikosR committed
67
      files: {
XhmikosR's avatar
XhmikosR committed
68
        'config.json': {
XhmikosR's avatar
XhmikosR committed
69
          content: configJson
fat's avatar
fat committed
70
71
72
73
74
75
        }
      }
    }
    $.ajax({
      url: 'https://api.github.com/gists',
      type: 'POST',
76
      contentType: 'application/json; charset=UTF-8',
fat's avatar
fat committed
77
78
79
      dataType: 'json',
      data: JSON.stringify(data)
    })
80
    .success(function (result) {
81
      var gistUrl = result.html_url;
XhmikosR's avatar
XhmikosR committed
82
      var origin = window.location.protocol + '//' + window.location.host
83
84
85
86
87
      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
88
    })
89
    .error(function (err) {
90
91
      try {
        showError('<strong>Ruh roh!</strong> Could not save gist file, configuration not saved.', err)
XhmikosR's avatar
XhmikosR committed
92
      } catch (sameErr) {
93
94
        // deliberately ignore the error
      }
95
      callback('<none>', '<none>')
fat's avatar
fat committed
96
97
98
    })
  }

fat's avatar
fat committed
99
  function getCustomizerData() {
fat's avatar
fat committed
100
101
102
    var vars = {}

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

    var data = {
      vars: vars,
fat's avatar
fat committed
109
110
      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
111
112
113
114
    }

    if ($.isEmptyObject(data.vars) && !data.css.length && !data.js.length) return

fat's avatar
fat committed
115
    return data
fat's avatar
fat committed
116
117
  }

118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
  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
136
  function parseUrl() {
fat's avatar
fat committed
137
    var id = getQueryParam('id')
fat's avatar
fat committed
138

fat's avatar
fat committed
139
    if (!id) return
fat's avatar
fat committed
140

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

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

    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')
169
170
      for (var jsFileName in js) {
        jsFolder.file(jsFileName, js[jsFileName])
fat's avatar
fat committed
171
172
173
      }
    }

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

181
    if (config) {
XhmikosR's avatar
XhmikosR committed
182
      zip.file('config.json', config)
183
184
    }

XhmikosR's avatar
XhmikosR committed
185
    var content = zip.generate({ type: 'blob' })
fat's avatar
fat committed
186
187

    complete(content)
fat's avatar
fat committed
188
189
  }

190
  function generateCustomLess(vars) {
fat's avatar
fat committed
191
192
193
194
195
196
197
198
199
    var result = ''

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

    return result + '\n\n'
  }

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

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

213
214
215
216
217
218
219
220
221
222
223
224
225
226
    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)
      }
    })
227
228
229
230

    return imports
  }

231
232
233
  function generateLESS(lessFilename, lessFileIncludes, vars) {
    var lessSource = __less[lessFilename]

234
    var lessFilenames = includedLessFilenames(lessFilename)
XhmikosR's avatar
XhmikosR committed
235
    $.each(lessFilenames, function (index, filename) {
236
237
238
239
240
241
242
243
244
245
      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'.
      if (fileInclude || (fileInclude == null))    lessSource += __less[filename]

      // Custom variables are added after Bootstrap variables so the custom
      // ones take precedence.
246
      if (('variables.less' === filename) && vars) lessSource += generateCustomLess(vars)
247
248
    })

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

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

    parser.parse(lessSource, function (err, tree) {
262
      if (err) {
263
        return promise.reject(err)
264
265
266
      }
      intoResult[baseFilename + '.css']     = cw + tree.toCSS()
      intoResult[baseFilename + '.min.css'] = cw + tree.toCSS({ compress: true })
267
      promise.resolve()
268
    })
269
270

    return promise.promise()
271
272
  }

273
  function generateCSS(preamble) {
274
    var promise = $.Deferred()
275
276
    var oneChecked = false
    var lessFileIncludes = {}
XhmikosR's avatar
XhmikosR committed
277
    $('#less-section input').each(function () {
278
279
280
281
282
283
      var $this = $(this)
      var checked = $this.is(':checked')
      lessFileIncludes[$this.val()] = checked

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

285
    if (!oneChecked) return false
fat's avatar
fat committed
286
287
288
289
290

    var result = {}
    var vars = {}

    $('#less-variables-section input')
291
292
293
      .each(function () {
        $(this).val() && (vars[$(this).prev().text()] = $(this).val())
      })
fat's avatar
fat committed
294

295
296
    var bsLessSource    = preamble + generateLESS('bootstrap.less', lessFileIncludes, vars)
    var themeLessSource = preamble + generateLESS('theme.less',     lessFileIncludes, vars)
fat's avatar
fat committed
297

298
299
300
301
    var prefixer = autoprefixer({ browsers: __configBridge.autoprefixerBrowsers })

    $.when(
      compileLESS(bsLessSource, 'bootstrap', result),
302
      compileLESS(themeLessSource, 'bootstrap-theme', result)
303
304
305
306
307
308
309
310
311
    ).done(function () {
      for (var key in result) {
        result[key] = prefixer.process(result[key]).css
      }
      promise.resolve(result)
    }).fail(function (err) {
      showError('<strong>Ruh roh!</strong> Could not parse less files.', err)
      promise.reject()
    })
fat's avatar
fat committed
312

313
    return promise.promise()
fat's avatar
fat committed
314
315
  }

316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
  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
334
    var $checked = $('#plugin-section input:checked')
335
336
    var jqueryCheck = __configBridge.jqueryCheck.join('\n')
    var jqueryVersionCheck = __configBridge.jqueryVersionCheck.join('\n')
337

fat's avatar
fat committed
338
339
340
341
342
343
344
    if (!$checked.length) return false

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

345
    preamble = cw + preamble
346
    js = jqueryCheck + jqueryVersionCheck + js
347

fat's avatar
fat committed
348
    return {
349
      'bootstrap.js': preamble + js,
350
      'bootstrap.min.js': preamble + uglify(js)
fat's avatar
fat committed
351
352
353
    }
  }

354
355
356
357
358
359
360
361
362
363
364
365
  function removeImportAlerts() {
    importDropTarget.nextAll('.alert').remove()
  }

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

    var file = (e.originalEvent.hasOwnProperty('dataTransfer')) ? e.originalEvent.dataTransfer.files[0] : e.originalEvent.target.files[0]

    var reader = new FileReader()

366
367
    reader.onload = function (e) {
      var text = e.target.result
368

369
370
      try {
        var json = JSON.parse(text)
371

372
373
        if (!$.isPlainObject(json)) {
          throw new Error('JSON data from config file is not an object.')
374
        }
375
376
377
378
379

        updateCustomizerFromJson(json)
        showAlert('success', '<strong>Woohoo!</strong> Your configuration was successfully uploaded. Tweak your settings, then hit Download.', importDropTarget)
      } catch (err) {
        return showAlert('danger', '<strong>Shucks.</strong> We can only read valid <code>.json</code> files. Please try again.', importDropTarget)
380
      }
381
    }
382

383
    reader.readAsText(file, 'utf-8')
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
  }

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

    removeImportAlerts()
  }

  if (supportsFile) {
    importDropTarget
      .on('dragover', handleConfigDragOver)
      .on('drop', handleConfigFileSelect)
  }

400
  $('#import-file-select').on('change', handleConfigFileSelect)
401
402
  $('#import-manual-trigger').on('click', removeImportAlerts)

fat's avatar
fat committed
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
  var inputsComponent = $('#less-section input')
  var inputsPlugin    = $('#plugin-section input')
  var inputsVariables = $('#less-variables-section input')

  $('#less-section .toggle').on('click', function (e) {
    e.preventDefault()
    inputsComponent.prop('checked', !inputsComponent.is(':checked'))
  })

  $('#plugin-section .toggle').on('click', function (e) {
    e.preventDefault()
    inputsPlugin.prop('checked', !inputsPlugin.is(':checked'))
  })

  $('#less-variables-section .toggle').on('click', function (e) {
    e.preventDefault()
    inputsVariables.val('')
  })

fat's avatar
fat committed
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
  $('[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++) {
      var dependency = $('[value="' + dependencies[i] + '"]')
      dependency && dependency.prop('checked', true)
    }
  })

  $('[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++) {
      var dependent = $('[value="' + dependents[i] + '"]')
      dependent && dependent.prop('checked', false)
    }
  })

fat's avatar
fat committed
444
445
446
  var $compileBtn = $('#btn-compile')

  $compileBtn.on('click', function (e) {
447
448
449
    var configData = getCustomizerData()
    var configJson = JSON.stringify(configData, null, 2)

fat's avatar
fat committed
450
451
452
453
    e.preventDefault()

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

454
455
456
457
458
459
460
461
462
    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'

463
464
465
466
467
468
469
470
471
      $.when(
        generateCSS(preamble),
        generateJS(preamble),
        generateFonts()
      ).done(function (css, js, fonts) {
        generateZip(css, js, fonts, configJson, function (blob) {
          $compileBtn.removeAttr('disabled')
          setTimeout(function () { saveAs(blob, 'bootstrap.zip') }, 0)
        })
472
      })
fat's avatar
fat committed
473
    })
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
  });

  // 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
492
      { type: 'image/svg+xml;charset=utf-8' }
493
494
    )
    var objectUrl = url.createObjectURL(svg);
495
496

    if (/^blob:/.exec(objectUrl) === null || !supportsFile) {
497
498
499
500
      // `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
501
    } else {
502
503
504
505
506
507
508
509
      $('<img>')
        .on('load', function () {
          $compileBtn.prop('disabled', false)
        })
        .on('error', failback)
        .attr('src', objectUrl)
    }
  })();
fat's avatar
fat committed
510

fat's avatar
fat committed
511
  parseUrl()
512
}