@ovh-ux/manager-navbar

v2.2.0

OVH control panel navbar

NPM

README

GitHub

Website

BSD-3-Clause

Latest version published 1 year ago

    npm install @ovh-ux/manager-navbar

We couldn't find any similar packages Browse all packages

Package Health Score

61 / 100

Popularity
Limited
Maintenance
Sustainable
Security
No known security issues
Community
Sustainable

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (5)

Dependents: 0
GitHub Stars: 83
Forks: 44
Contributors: 50

The npm package @ovh-ux/manager-navbar receives a total of 5 downloads a week. As such, we scored @ovh-ux/manager-navbar popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @ovh-ux/manager-navbar, we found that it has been starred 83 times, and that 0 other projects in the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

0.5.2

0.6.2

1.3.1

2.1.3

2.2.0

Indirect Vulnerabilities

0.5.2

0.6.2

1.3.1

2.1.3

2.2.0

License Risks

0.5.2

0.6.2

1.3.1

2.1.3

2.2.0

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

BSD-3-Clause

Security Policy

We found a way for you to contribute to the project! Looks like @ovh-ux/manager-navbar is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like @ovh-ux/manager-navbar is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test @ovh-ux/manager-navbar

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 28
Merged PR: 3.87K
Open PR: 43
Last Commit: 3 days ago

Further analysis of the maintenance status of @ovh-ux/manager-navbar based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

An important project maintenance signal to consider for @ovh-ux/manager-navbar is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme.md: No
Contributing.md: No
Code of Conduct: Yes
Contributors: 50
Funding: No

With more than 10 contributors for the @ovh-ux/manager-navbar repository, this is possibly a sign for a growing and inviting community.

How about a good first contribution to this project? It seems that @ovh-ux/manager-navbar is missing a README file.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 2 years
Dependencies: 2 Direct / 2 Total
Versions: 45
Install Size: 1.51 MB
Dist-tags: 1
# of Files: 239
Maintainers: 9
TS Typings: No

We detected a total of 2 direct & transitive dependencies for @ovh-ux/manager-navbar. See the full dependency tree of @ovh-ux/manager-navbar

@ovh-ux/manager-navbar has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

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.

License