Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/975l/includelibrarybundle

IncludeLibraryBundle will let you specify which library and version to include, version can use wildcard "*"
https://github.com/975l/includelibrarybundle

bootstrap css javascript jquery libraries library symfony symfony-bundle

Last synced: 11 days ago
JSON representation

IncludeLibraryBundle will let you specify which library and version to include, version can use wildcard "*"

Host: GitHub
URL: https://github.com/975l/includelibrarybundle
Owner: 975L
License: mit
Created: 2018-02-23T12:26:45.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2024-09-12T10:26:25.000Z (2 months ago)
Last Synced: 2024-09-12T21:51:19.732Z (2 months ago)
Topics: bootstrap, css, javascript, jquery, libraries, library, symfony, symfony-bundle
Language: PHP
Homepage: https://975l.com/en/pages/include-library-bundle
Size: 247 KB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # IncludeLibraryBundle

Fed up of having to look to latest, or specifc, version of jQuery, Bootstrap, etc. IncludeLibraryBundle is made for you ;-)

Want to replace this

```html

    

    

    

```

by this?

```html

    {{ inc_lib('bootstrap', 'css', '3.3.7') }}

    {{ inc_lib('bootstrap', 'js', '3.3.7') }}

```

IncludeLibraryBundle will let you specify which library and version to include, version can use wildcard "*". **It will do a lot more**, see "How to use" below.

Subresource Integrity are provided, even for the libraries that don't provide them, based on [https://www.srihash.org/](https://www.srihash.org/)

You can also include [Google Font](https://fonts.google.com), see below.

[IncludeLibraryBundle dedicated web page](https://975l.com/en/pages/include-library-bundle).

[IncludeLibraryBundle API documentation](https://975l.com/apidoc/c975L/IncludeLibraryBundle.html).

## Bundle installation

### Step 1: Download the Bundle

Use [Composer](https://getcomposer.org) to install the library

```bash

    composer require c975l/includelibrary-bundle

```

### How to use

IncludeLibraryBundle provide the following Twig extension functions `inc_lib()`, `inc_link()`, `inc_content()` and `inc_font()`

### Include Library - `inc_lib()`

Simply add `{{ inc_lib('library', 'type', 'version', 'params') }}` to your header and that's it!

- library is the name of the library (see below Supported libraries). It is case unsensitive and can have "-" or "_", if you want to use 'BoOsTrap', it will work ;-).

- type is `css` or `js` or `local`, also case insensitive.

- version is the version wanted, it can use wildcard or be omitted to get the latest one.

- params is the parameters you want to add when calling a javascript.

### Examples

`{{ inc_lib('bootstrap', 'css') }}`: Latest version

`{{ inc_lib('bootstrap', 'css', '3.3.7') }}`: Specific version

`{{ inc_lib('bootstrap', 'css', '3.*') }}`: Wildcard MAJOR version

`{{ inc_lib('bootstrap', 'css', '3.3.*') }}`: Wildcard MINOR version

`{{ inc_lib('bootstrap', 'css', '3.3.3.*') }}`: Wildcard PATCH version

`{{ inc_lib(absolute_url(asset('css/styles.min.css')), 'local') }}`: local file

### Local file

To include a local file, you need to provide an **absolute url**. **Important** the type is determined by the extension provided in the url, so it has to be '.css' or '.js'. While it's not really useful for `inc_lib()`, it is for `inc_content()` (see below) as it will allow to include the content of the called library in the html, which can be useful when creating PDF files with `wkhtmltopdf` for example.

### Javascript parameters

For **javascript**, if you need to add some url query parameters, you can do so by calling the fourth argument `params` of `inc_lib()`. Works also for local file.

For example, Tinymce needs an apiKey, so call it like this: `{{ inc_lib('tinymce', 'js', 'stable', '?apiKey=YOUR_API_KEY') }}`, you simply need to provide the full query parameters, including "?" and "&" as it will be added to the srcipt call.

### Just get link - `inc_link()`

You can also use `inc_link` in the same way `{{ inc_link('bootstrap', 'css', '3.*') }}` to get only the href (css) or src (js) part (url). **Does not work for a local file** as it will return the same url as provided.

For example, Tinymce needs to get the css used on the website to display using those styles, so we need to provide it the url, `inc_link` will do so :

```javascript

    tinymce.init({

        content_css : [

            '{{ inc_link('bootstrap', 'css', '3.*') }}',

        ],

    //...

    });

```

### Get content - `inc_content()`

If you need to get the content to include, i.e. for `wkhtmltopdf`, you can use the function `inc_content` in the same way `{{ inc_content('bootstrap', 'css', '3.*') }}`. Works also for local file. Content will be wrapped within `` for `css` and `` for `js`.

### Include Google font - `inc_font()`

All you have to do is to worry about its name! Find your [Google Font](https://fonts.google.com/), pick its name and call it with `{{ inc_font('FONT_NAME') }}`. That's it! Now you can refer, using the same names in your css files!

## Supported libraries

Use following names and versions (+ wildcard if wanted, as indicated above) in the functions `inc_lib`, `inc_link` or `inc_content`:

To find supported versions check the sub-folders of `src/integrities`

- **[Angular](https://angularjs.org) (javascript)**

- **[Bootstrap](http://getbootstrap.com) (css + javascript)**

- **[Bootstrap DatePicker](https://github.com/uxsolutions/bootstrap-datepicker) (css + javascript)**

- **[CookieConsent](https://cookieconsent.insites.com) (css + javascript)**

- **[jQuery + Slim](https://jquery.com) (javascript)**

- **[jQueryUI](https://jquery.com/ui) (javascript)**

- **[FontAwesome + Base + Regular + Brands + Solid](https://fontawesome.com) (css + javascript)**

- **[Popper](https://popper.js.org) (javascript)**

- **[React](https://reactjs.org) (javascript)**

- **[Select2](https://select2.org) (css + javascript)**

- **[Tinymce](https://www.tinymce.com) (javascript)**

## How to add libraries and/or versions

- Go into the folder `Libraries`,

- Open the library class (or add it if not present),

- Locate the corresponding method `getCss()` or `getJavascript()`,

- If you add new Library, add method `getVersion()`,

- Add versions and wildcards to the methods `getVersion()`, keeping the latest above,

- Add the needed data (take example on existing ones).

Feel free to make PR's to add other libraries/versions :-)

If this project **help you to reduce time to develop**, you can sponsor me via the "Sponsor" button at the top :)