@ovh-ux/manager-navbar NPM

manager-navbar

Install

yarn add @ovh-ux/manager-navbar

Usage

import angular from 'angular';
import ovhManagerNavbar from '@ovh-ux/manager-navbar';

angular
  .module('myApp', [
    ovhManagerNavbar,
  ]);

<ovh-manager-navbar></ovh-manager-navbar>

Options

Lang

Pass an object as lang-options to configure language menu

<ovh-manager-navbar
    data-lang-options="$ctrl.langOptions">
</ovh-manager-navbar>

Exclude

Add an exclude property which takes an array of langs that should be excluded

{
  exclude: ['fr_FR']
}

Will exclude 'fr_FR' lang

Include

Add an include property which takes an array of langs that should be excluded

{
  include: ['en_GB']
}

Will only include 'en_EN' lang

Priorities

exclude property will override include property

Supported langs

The supported langs are

de_DE
en_GB
en_CA
en_US
en_AU
en_ASIA
en_SG
es_ES
fr_FR
fr_CA
it_IT
lt_LT
nl_NL
pl_PL
pt_PT
fi_FI
cs_CZ

If the given options aren't supported, an error will be thrown

Changing lang

When the lang is being changed, the event lang.onChange is emitted

Other

Other options will be passed through navbar-options

<ovh-manager-navbar
    data-navbar-options="$ctrl.navbarOptions">
</ovh-manager-navbar>

Toggle

Allows to configure responsive toggler

Event

Listens to event to stop toggler loading

{
  toggle: {
    event: 'sidebar:loaded'
  }
}

universe

Indicate current universe

{
  universe: 'web'
}

fixed position

Indicate if fixed position should be applied to component

{
  fixed: true
}

Build

# Build in production mode
yarn start

Development

If you want to contribute to the project, follow theses instructions:

Foremost, you should launch a global installation at the root folder of this repository:

yarn install

Then you just have to start the project in development mode. For this, two choices are possible according to your needs:

# Build the `manager-navbar` workspace and all the nested workspaces in development mode and watch only `manager-navbar` workspace
yarn start:dev
# Build and watch the `manager-navbar` workspace and all the nested workspaces in development mode
yarn start:watch

Contributing

Always feel free to help out! Whether it's filing bugs and feature requests or working on some of the open issues, our contributing guide will help get you started.