Giter Club home page Giter Club logo

regauth's Introduction

regauth

Login, signup pages & widgets.

Installing

To use this package:

Add the following to your pubspec.yaml file:

dependencies:
  regauth:
    git: https://github.com/nibaji/regauth.git

Usage

For the Signin form alone:

SignInForm(
    signInLink: "<signin endpoint>",
    signUpLink: "<signup endpoint>",
    theAppName: "<the app / Org name>",
    leadToSignUpPage: false, // leave it blank or make it "true" to have link for SignUp page
    signInMapMailIDKey: "mailId", // Specify the key for the mailid the signin endpoint expects in the map.
    signInMapPasswordKey: "password", // Specify the key for the password the signin endpoint expects in the map.
    
    // leave [signUpMap*Key] parameters untouched, if [leadToSignUpPage] is not set to true.
    signUpMapFullNameKey: "full_name", // Specify the key for the mailid the signup endpoint expects in the map.
    signUpMapMobileNumberKey: "mobile", // Specify the key for the password the signup endpoint expects in the map.
    signUpMapMailIDKey: "mailId", // Specify the key for the user's name the signup endpoint expects in the map.
    signUpMapPasswordKey: "password", // Specify the key for the user's mobile number the signup endpoint expects in the map.
),

For the whole Signin Page:

SignInPage(
    signInLink: "<signin endpoint>",
    signUpLink: "<signup endpoint>",
    theAppName: "<the app / Org name>",
    leadToSignUpPage: false, // leave it blank or make it "true" to have link for SignUp page
    signInMapMailIDKey: "mailId", // Specify the key for the mailid the signin endpoint expects in the map.
    signInMapPasswordKey: "password", // Specify the key for the password the signin endpoint expects in the map.

    // leave [signUpMap*Key] parameters untouched, if [leadToSignUpPage] is not set to true.
    signUpMapFullNameKey: "full_name", // Specify the key for the mailid the signup endpoint expects in the map.
    signUpMapMobileNumberKey: "mobile", // Specify the key for the password the signup endpoint expects in the map.
    signUpMapMailIDKey: "mailId", // Specify the key for the user's name the signup endpoint expects in the map.
    signUpMapPasswordKey: "password", // Specify the key for the user's mobile number the signup endpoint expects in the map.
),

Note: Signin Page and form shall lead to signup page if "leadToSignUpPage" parameter is not set to false.

CONTRIBUTORS

regauth's People

Contributors

nibaji avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.