https://github.com/mauriciolauffer/openui5-password

An OpenUI5 Control which checks password strength and validates it against predefined rules
https://github.com/mauriciolauffer/openui5-password

javascript openui5 openui5-framework openui5-password password plugin sap sapui5 ui5

Last synced: 9 days ago
JSON representation

An OpenUI5 Control which checks password strength and validates it against predefined rules

• Host: GitHub
• URL: https://github.com/mauriciolauffer/openui5-password
• Owner: mauriciolauffer
• License: mit
• Created: 2017-06-17T12:22:39.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-21T07:20:04.000Z (11 months ago)
• Last Synced: 2024-10-09T02:09:30.060Z (28 days ago)
• Topics: javascript, openui5, openui5-framework, openui5-password, password, plugin, sap, sapui5, ui5
• Language: JavaScript
• Homepage: https://mauriciolauffer.github.io/openui5-password/demo/webapp/index.html
• Size: 1.26 MB
• Stars: 7
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# openui5-password

[![npm](https://img.shields.io/npm/v/openui5-password)](https://www.npmjs.com/package/openui5-password) [![test](https://github.com/mauriciolauffer/openui5-password/actions/workflows/test.yml/badge.svg)](https://github.com/mauriciolauffer/openui5-password/actions/workflows/test.yml)

An OpenUI5 Control which checks password strength and validates it against pre-defined rules.

The control is an input with password type and parameters to enable validation rules.

## Demo

You can check out a live demo here:

![Demo Screenshot](./openui5-password.png)

## Project Structure

* demo - Library's live demo

* dist - Distribution folder which contains the library ready to use

* src  - Development folder

* test - Testing framework for the library

## Getting started

### Installation

Install openui5-password as an npm module

```sh

$ npm install openui5-password

```

### Configure manifest.json

Add the library to *sap.ui5/dependencies/libs* and set its path in *sap.ui5/resourceRoots* in your manifest.json file, as follows:

```json

{

  "sap.ui5": {

    "dependencies": {

      "libs": {

        "openui5.password": {}

      }

    },

    "resourceRoots": {

      "openui5.password": "./FOLDER_WHERE_YOU_PLACED_THE_LIBRARY/openui5/password/"

    }

  }

}

```

### How to use

Import openui5-password to your UI5 controller using *sap.ui.require*:

```javascript

sap.ui.require([

  'openui5/password/Password'

], function (Password) {

  const passwordInput = new Password({

    requireNumbers: true,

    requireLetters: true,

    requireSymbols: true,

    requireLowercase: true,

    requireUppercase: true,

    minLength: 5,

    maxLength: 42

  });

});

```

## Config Parameters

| Name | Type | Default| Description

| :---- | :------------------- | :---- | :---------  |

| maxLength | integer | 0 | Maximum number of characters. Value '0' means the feature is switched off.

| minLength | integer | 0 | Minimum number of characters. Value '0' means the feature is switched off.

| requireNumbers | boolean | true | Indicates that input must contain numbers

| requireSymbols | boolean | true | Indicates that input must contain symbols

| requireLetters | boolean | true | Indicates that input must contain letters

| requireLowercase | boolean | true | Indicates that input must contain lowercase letters

| requireUppercase | boolean | true | Indicates that input must contain uppercase letters

| score | integer | 0 | The score is a number which indicates the password strength.

## Author

Mauricio Lauffer

* LinkedIn: [https://www.linkedin.com/in/mauriciolauffer](https://www.linkedin.com/in/mauriciolauffer)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details