Download the PHP package wbrowar/craft-admin-bar without Composer

On this page you can find all versions of the php package wbrowar/craft-admin-bar. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of wbrowar/craft-admin-bar

Informations about the package craft-admin-bar

Admin Bar for Craft CMS 4

Admin Bar is made up of two parts:

If you are creating a Craft CMS site with a Twig front end, you can use this plugin and its Twig tag to add Admin Bar to your front end.

If you are creating a headless site, or a site that is statically cached, you may not need this plugin, and in that case you can add Admin Bar Component directly into your site’s JavaScript (via a bundler or a <script> tag).

:warning: Admin Bar’s composer package name has changed from wbrowar/adminbar to wbrowar/craft-admin-bar. Update your composer.json to point to the new package on Packagist.

Requirements

Installation

To install the plugin, you can find it in the Craft Plugin Store, or follow these instructions:

  1. Open your terminal and go to your Craft project:

  2. Then tell Composer to require the plugin:

  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Admin Bar.

Add Admin Bar to Your Twig Template

To add Admin Bar to your website add the {{ adminBar() }} tag within your Twig template. Admin Bar will be displayed on any page that includes this tag when someone—who has the permission to view the CP—is logged into your website.

In your plugin settings you can use CSS Custom Properties to override the look of your admin bar to match your website’s look and feel.

You may pass in an array of arguments to make some changes on how Admin Bar looks and functions. In this example, you may pass in the entry that you'd like to edit when someone clicks the "Edit" link.

Here is a list of available arguments:

Argument Default Description
editLinkLabel null Set a custom label for the Edit Link when editLinkUrl is set to a custom URL.
editLinkUrl null Override the Edit Link with a custom URL or URI (this will be run through the url() Twig function).
entry null Pass in an entry object to add an edit link for that entry .
fixed false Use CSS position: fixed instead of position: sticky;.
force false Bypasses the default check that {{ adminBar() }} does to see if Admin Bar can be rendered.
position 'top' When set to 'bottom' and used with fixed: true, Admin Bar will be fixed to the bottom of the page. Accepts: 'bottom', 'top'
rtl false Changes the reading direction from ltr to rtl in situations where you need to manually set it. Admin Bar Component will automatcally switch to RTL if your page is set to RTL or if you have the CSS set to direction: rtl.
sticky true Uses CSS to position: sticky; Admin Bar to the top of the page.
textElements [] Add text elements to admin bar using an array of objects.
useCss true Add the default styles to Admin Bar or leave them out to load the stylesheet with your project’s CSS.
useJs true Use the Admin Bar's default Javascript or set this to false to import the Admin Bar Component into your project’s JS bundle.

Adding Text Elements to Admin Bar

Plain text and labels can be added to Admin Bar by adding objects into the textElements argument. Object properties can include any property accepted by <admin-bar-text> elements, as documented here. Each object will add a new text element and the properties in each object will be added using Craft’s attr() method.

For example, this will add a line of text that will display the number of entries in the current entry’s section:

Configuration settings

The config file gives you the ability to adjust how Admin Bar looks and functions in multiple environments. It also allows you to create additional links for the Admin Bar, and allows for plugin actions to be called through these additional links.

To add a config file to your site, create a file at /config/admin-bar.php that returns an array of settings:

Here are the settings you can change with the config file:

Admin Bar

Setting Default Description
additionalLinks [] Add links to Admin Bar using the properties found below.
displayGreeting true Displays the logged in user's photo (if it's set) and "Hi, [friendlyname]".
displayDashboardLink true A link to the CP Dashboard.
displayDefaultEditSection true Display the name of the section in the default entry/category edit link if the user has permission to edit it.
displayGuideLink true If the Guide plugin is installed, a link to the Guide CP Section is displayed.
displayLogout true Displays a button that logs you out of Craft CMS.
displaySettingsLink true A link to the CP Settings page that appears only to admins.

Additional Links

You can add links to Admin Bar using the config file by passing properties into an array, called additionalLinks. There are examples commented out in the config.php file, and here are the properties you can use to create links.

Property Values Description
title string Appears as the label for the link
url string Depending on the type property, the url represents the location or action of the link
title 'url', 'cpUrl', 'action' If the type is 'url', the url value should be an absolute URL or a path relative to the site root. If the type is 'cpUrl', the url value should be a path relative to your site's CP root. If the type is 'action', set the value for url to the path used by the Controller Action
params string Passes along url parameters, as documented here. This only supports this string format: 'foo=1&bar=2'
protocol string Changes the url protocol, as documented here
mustShowScriptName string Appends index.php, as documented here
permissions array An array of required permissions that are needed for this link to be displayed. All permissions in this array will be required for the link to appear

Optimizing CSS and JS Delivery for Performance

By default, using {{ adminBar() }} will render HTML, and it will link to the static CSS and JS assets that make Admin Bar work. The CSS is loaded in a file in the <head> and the JavaScript is loaded in a file at the bottom of the <body> tag—deferred so it’s not render blocking.

Because these add extra requests to your server, you may prefer to move the CSS and JS code into your Twig template. First, to turn off the deafult loading behavior, add useCss and useJs arguments to your embed code and set them both to false:

This turns off loading any JavaScript or CSS onto the page. To load those assets back in, you can add the following anywere on your Twig template:

[!NOTE] How you embed your static assets are up to you. One less server request is usually better, but adding a few extra KB to every page in your HTML markup might not be as performant as caching and loading static .css and .js files.

Dynamically Loading Admin Bar

Using Admin Bar with Blitz Static Caching

The Blitz Craft CMS plugin provides a Twig function, called includeDynamic(), that lets you render a Twig template on a statically-cached page. With this function, Admin Bar can be dynamically included into your template so it will work on cached and uncached pages.

With Blitz installed, you can start by moving the {{ adminBar() }} method from your Twig templates into a separate Twig file in your templates directory. For this example, we’ll add the following code to a file at /templates/includes/admin-bar.twig.

Notice that useCss and useJs are both set to false. This is because registering CSS and JS files from dynamic includes won’t work on a statically-cached page. You can set any other adminBar() argument that you’d like here.

Next, call the dynamicInclude() function in the place in your layout or page template where you would like Admin Bar to be embedded:

You can pass parameters into includeDynamic(), so we can pass the URI of the current page entry—which will be used to figure out what page Admin Bar will use as the "Edit" button.

In order to load Admin Bar’s CSS and JS onto the front end, we can use Admin Bar’s built-in Twig functions anywhere within our template.

Releases

Release notes can be found at CHANGELOG.md

Supported Versions

Here is a general goal for adding and supporting features for Admin Bar going forward:

Brought to you by Will Browar

All versions of craft-admin-bar with dependencies

PHP Build Version
Package Version
Requires craftcms/cms Version ^5.0.0
nystudio107/craft-code-editor Version ^1.0.18
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package wbrowar/craft-admin-bar contains the following files

Loading the files please wait ....