boosted

Boosted

Boosted is a fork of Bootstrap. Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development.
Visit Boosted

Report bug · Request feature

Table of contents

• Quick start
• Status
• What's included
• Bugs and feature requests
• Documentation
• Contributing
• Versioning
• Creators
• Thanks
• Copyright and license

Quick start

Several quick start options are available:

• Download the latest release.
• Clone the repo: git clone https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap.git
• Install with npm: npm install boosted
• Install with yarn: yarn add boosted@4.5.0
• Install with Composer: composer require Orange-OpenSource/Orange-Boosted-Bootstrap:4.5.0
• Install with NuGet: CSS: Install-Package boosted Sass: Install-Package boosted.sass

Read the Getting started page for information on the framework contents, templates and examples, and more.

Status

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:

boosted/
└── dist/
    ├── css/
    │   ├── boosted-grid.css
    │   ├── boosted-grid.css.map
    │   ├── boosted-grid.min.css
    │   ├── boosted-grid.min.css.map
    │   ├── boosted-reboot.css
    │   ├── boosted-reboot.css.map
    │   ├── boosted-reboot.min.css
    │   ├── boosted-reboot.min.css.map
    │   ├── boosted-utilities.css
    │   ├── boosted-utilities.css.map
    │   ├── boosted-utilities.min.css
    │   ├── boosted-utilities.min.css.map
    │   ├── boosted.css
    │   ├── boosted.css.map
    │   ├── boosted.min.css
    │   └── boosted.min.css.map
    └── js/
        ├── boosted.bundle.js
        ├── boosted.bundle.js.map
        ├── boosted.bundle.min.js
        ├── boosted.bundle.min.js.map
        ├── boosted.esm.js
        ├── boosted.esm.js.map
        ├── boosted.esm.min.js
        ├── boosted.esm.min.js.map
        ├── boosted.js
        ├── boosted.js.map
        ├── boosted.min.js
        └── boosted.min.js.map

We provide compiled CSS and JS (boosted.*), as well as compiled and minified CSS and JS (boosted.min.*). source maps (boosted.*.map) are available for use with certain browsers' developer tools. Bundled JS files (boosted.bundle.js and minified boosted.bundle.min.js) include Popper.

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

Boosted's documentation, included in this repo in the root directory, is built with Hugo and publicly hosted on GitHub Pages at https://boosted.orange.com/. The docs may also be run locally.

Documentation search is powered by Algolia's DocSearch. Working on our search? Be sure to set debug: true in site/assets/js/src/search.js file.

Running documentation locally

1. Run npm install to install the Node.js dependencies, including Hugo (the site builder).
2. Run npm run test (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
3. From the root /boosted directory, run npm run docs-serve in the command line.
4. Open http://localhost:9001/ in your browser, and voilà.

Learn more about using Hugo by reading its documentation.

Documentation for previous releases

You can find all our previous releases docs on https://boosted.orange.com/docs/versions/.

Previous releases and their documentation are also available for download.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Boosted is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we adhere to those rules whenever possible.

See the Releases section of our GitHub project for changelogs for each release version of Boosted.

Creators

Bootstrap

Mark Otto

• https://twitter.com/mdo
• https://github.com/mdo

Jacob Thornton

• https://twitter.com/fat
• https://github.com/fat

Boosted

Yves Gatesoupe

• https://github.com/ygatesoupe

Loïc Laussel

• https://github.com/Lausselloic/

Gaël Poupard

• https://github.com/ffoodd

Thanks

Thanks to BrowserStack for providing the infrastructure that allows us to test in real browsers!

Thanks to Netlify, we are able to deploy pre-releases at Boosted and auto-deploy pull requests.

Copyright and license

Code and documentation copyright 2011-2020 the Bootstrap Authors and Twitter, Inc. Code released under the MIT License. Docs released under Creative Commons.

Boosted code and documentation copyright 2015-2020 the Boosted Authors and Orange SA. Code released under the MIT License. Docs released under Creative Commons.

Changelog

5.0.0-alpha1 (2020-06-22)

<details> <summary>Alerts</summary>

• alerts: dismissible alerts height (a86753e
• alerts: icon sizes and alignment (a36c058)
• alerts: new variant for close icon in alerts (1da0abe)
• alerts: Orange branded :tada: (772d3da)

</details> <details> <summary>Badges</summary>

• badges: proper alignments and spacings (d93f738)
• badge: add sizes variants to badges and include a white info version when badge is large enough (859cc5e)
• badge: improve sizes variants' spacings (33b52e6)
• badge: restore Bootstrap defaults and unset letter-spacing (75ffee5)

</details> <details> <summary>Breadcrumb</summary>

• breadcrumb: matching the brand (8d9c6fa)

</details> <details> <summary>Button group</summary>

• button-group: Orange branded :tada: (3ec1cc6)
• button-group: ensure active and focus buttons displays outlines (68bc83b)

</details> <details> <summary>Buttons</summary>

• buttons: ensure text is centered (aefea46)
• buttons: enhance focus with box-shadow alongside outline-offset (a66c567)
• buttons: Orange branded :tada: (c06e355)

</details> <details> <summary>Modals</summary>

• modal: Orange branded :tada: (7117d47)
• modal: get Bootstrap modal sizes back (7c377bc)

</details> <details> <summary>Close button</summary>

• close: Orange branded :tada: (2dab62d)
• close button: use Zeplin's defined cross for close button (332f4f3)
• close icon: get outline back on :hover (7deafac)

</details> <details> <summary>Forms</summary>

• form-checks: needed some tweaks after pulling Bootstrap's master (1e78211)
• forms: drop .form-control-sm leftover (00789c2)
• forms: feedback message should be small (cca3f1c)
• forms: remove label color change depending on status for #249 (f4a1b8d)
• forms: convey status using icon in feedback message to stop relying on color only, for #249 (95e6f6c)
• forms: custom select arrow sizing+position (3ac4187)
• forms: custom switch icons sizing+alignment (a2a2ffe)
• forms: get background-image back for custom checkboxes (edfdded)
• forms: get rid of form-*-sm things, forbidden by the brand (8d41b61)
• forms: labels positionning (5be3b52)
• forms: Orange branded :tada: (7c71cff)
• forms: remove info icon from invalid custom select (a4c82db)

</details> <details> <summary>Navbars</summary>

• navbar: ensure logo's hit target is properly setup for master logo (de81a44)
• navbar: get padding back on containers (b7fe932)
• navbar: h2 → h6 unecessary in .navbar-brand (190e1ef)
• navbar: Orange branded :tada: (9bcbab0)
• navbar: restore navbar color schemes (fdf17a1)

</details> <details> <summary>Navs</summary>

• navs: Orange branded :tada: (3ac8c25)
• navs: Orange branded nav-tabs :tada: (af93f30)

</details> <details> <summary>Pagination</summary>

• pagination: improve focus styles (e14c2dd)
• pagination: need at least intial size for #283 (aedf246)
• pagination: Orange branded :tada: (108e17c)
• pagination: remove pagination size variants forbidden by Orange Brand for #283 (cf70027)

</details> <details> <summary>Tables</summary>

• tables: more precise line-heights (553cb10)
• tables: vertical spacings were wrong (02c7b9a)
• tables: missing unit in table-cell-padding (acaf48a)
• tables: ensure tables match Orange Digital Guidelines (af31c78)
• tables: remove .thead-{dark|light} variants (dcd2bbd)
• tables: remove bordered+borderless tables (5c06087)
• tables: remove contextual classes for tables (3158486)
• tables: remove striped rows tables (38767c2)
• tables: remove table variants forbidden by Orange Brand for #283 (1ed8b39)
• tables: removed .table-lg and adjust default+sm sizes (ce13796)
• tables: simplify tables CSS and adjust sizings (1b3e641)

</details> <details> <summary>Other components</summary>

• cards: Orange branded :tada: (6340954)
• carousel: Orange branded :tada: (e90edb8)
• collapse: Orange branded :tada: (ee8b3ef)
• dropdowns: Orange branded :tada: (b0194a7)
• list group: Orange branded :tada: (0d90508)
• popovers: Orange branded :tada: (9c157f0)
• progress: Orange branded :tada: (c31b8ab)
• spinners: Orange branded :tada: (45bb26c)
• toasts: Orange branded :tada: (8f073ff)
• tooltips: Orange branded :tada: (090ad2a)

</details>

Core

<details> <summary>Deep branding</summary>

• fonts: use Helvetica Neue and document all the things (20ef6b9)
• type: set Orange's typescale (ea16528)

</details> <details> <summary>Colors and contrasts</summary>

• color-yiq: missing primary exception for Boosted… (a3e272f)
• contrast threshold: 4.5 instead of 3 (ed6aba7)
• color-yiq: use @ysds lookup table instead of pow polyfill (d07c67b)
• colored links: restrict to primary and light, and ensure contrasts (104e43c)
• colors: improve .text-body & .text-muted utilities to ensure proper contrasts, to close #274 (0d62c74)
• colors: lock color & background-color together in utilities, and use supporting colours for background utilities (5998d6a)
• colors: remove .text-{success|info|warning|danger} utilities (1ecdbe0)
• contrasts: set min-contrast-ratio to 4.5 (357448f)

</details> <details> <summary>Focus visibility</summary>

• focus-visible: default enhanced focus styles using outline-offset (0ab40fb)
• focus-visible: drop outline removals everywhere (982dcec)
• focus-visible: forms focus styles, almost matching v4-dev (a0522ea)
• focus-visible: increase focus visibility everywhere (7b4e6b3)
• focus-visible: raw implementation (64ad4b6)
• focus-visible: cleaner import (4175671)

</details> <details> <summary>Utilities</summary>

• text: ensure reset-text() mixin uses our base letter-spacing (838c802)
• text-muted: opacity applies to children, which is undesired (a11fb13)
• utilities: ensure .lh-lg is bigger than .lh-base (bf85bd6)
• utilities: ensure transparent/inherit are avoided in utility generation when locking background w foreground (601b110)
• utilities: supporting colour for danger used to be purple, not pink (5bc6fee)
• utilities: remove useless aliases (d002cb3)
• bg-utilities: .bg-{success|warning|danger|info} now uses supporting colours instead of functionnal ones (f2b11dd)
• border-radius: ensure .rounded-circle interop with BS, thus prevent everything from being rounded… in #283 (b88a4ab)
• borders: add .border-sm utility (df95392)
• borders: add missing border utilities to match the brand (85e1bb7)
• utilities: add border-color utilities, looping through grays (bcd4b62)
• utilities: amend documentation for border-colors, including grays (5639866)
• utilities: remove .text-uppercase utility forbidden by Orange Brand for #283 (05c9bfa)
• utilities: remove border-radius utilities and values forbidden by Orange Brand for #283 (a94291b)
• utilities: remove box-shadow utilities and values forbidden by Orange Brand for #283 (fe3dfa4)
• utilities: remove font-weight utilities forbidden by Orange Brand for #283 (540ae47)

</details> <details> <summary>Variables</summary>

• variables: duplicated value made variable unused (67b0855)
• variables: unused -shadow-lg for #283 (b45e7b0)
• variables: apply Boosted variables, nullify unused Bootstrap ones — compiling without components for now (ab43d22)
• variables: comment unused variables — forbidden by Orange Brand — for #283 (82d844b)
• variables: use Boosted v4 values and make it compile + pass linter (56f9077)

</details>

Docs

• docs: linter for application.js (34ddf32)
• docs: main script was calling bootstrap instead of boosted (7217297)