Download the PHP package ucomm/a11y-menu without Composer

On this page you can find all versions of the php package ucomm/a11y-menu. 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 ucomm/a11y-menu

Informations about the package a11y-menu

a11y Menu

This project aims to create a re-useable and accessible main navigation module. There are a few goals...

Usage

Installing via NPM

This package can be installed via npm using npm install a11y-menu. This will provide access to the JS and sass files, but not the WordPress menu walker. The intention is to give javascript developers access to the JS menu walker, navigation script, and styles in a way that can be used with webpack or other bundlers.

Creating a menu via JS

There are two functions and one stylesheet that can be used together to create an accessible menu.

displayMenu() takes a json file (see /mock-data below for the format). It can be imported and used as follows

This can be combined with the Navigation class to create a working menu with submenus that display on either click or hover events.

main.scss can be required using webpack or similar. Another option is to include in your project the transpiled css file that can be found at dist/main.css.

Installing via Composer.

This package can be installed as a dependency via Composer. To check if you have Composer installed, run the composer command in the terminal. If Composer's not available, install it. Then within your project run composer require ucomm/a11y-menu.

Creating a menu with PHP

For non-WordPress PHP projects, you can use the aberkow/a11y-menu-php composer package. The package takes the place of the javascript displayMenu function for PHP projects. It can be installed with composer require aberkow/a11y-menu-php and exposes a single static method which can be used like this:

Creating a WordPress menu in a theme.

In order to use the custom Walker within your theme, you'll need to do the following

Javascript Defaults

The constructor comes with the following defaults. These can be overridden as needed

Most basic case

The Navigation class is designed to be as simple to use as possible. In order to use it, create a new Navigation constructor and assign it to a variable. Inside of an event listener, use the init method on the the instance. This implementation will create a hover menu.

Overridding defaults

Defaults can be overridden individually or together.

This will create a nav menu with an id of main-nav and it will use the click functionality instead of hover.

Sass defaults

The stylesheet provided is meant to provide a skeleton on which to add additional styles (e.g. colors, padding, etc...). An example of adding icons is provided in src/scss/icon-styles.scss. These styles will override the baseline text icons in favor of Font Awesome icons.

Overriding and changing the styles of the menu is as easy as either making the selectors more specific or placing your custom styles lower in the cascade. Greater specificity can be achieved by using the provided am- class names.

Development

To begin developing

This will begin watching the js and scss files and place them in the appropriate directories. Navigation.js and main.scss will be transpiled and sent to /dist. Serving /public/index.html will read those files from the /dist directory.

Production

To create a new production version run npm run build.

Structure

/public

index.html

Loads two examples of the menu for testing. The first example is created via javascript. The second is hardcoded into the file. This is to test how the menu responds when javascript is not available.

/build

Built assets from /src will be placed here and used by index.html

/css and /js

These are examples of overrides/additions for the base css and/or js can be tested here. This is especially useful for styling since the base styles that are created are largely unopinionated.

/src

/js/Navigation

The class that

/js/utils

Exports a helper function to create a menu based on a tree-like json file

/mock-data

json files to create menus. The structure of items in the test file needs to be

The sub and classes keys are optional.

/scss

Base styles for the menu.

gulp.js

Watches and builds js/scss files as appropriate.

webpack.config.js

Handles bundling for local testing.

All versions of a11y-menu with dependencies

PHP Build Version
Package Version
No informations.
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 ucomm/a11y-menu contains the following files

Loading the files please wait ....