`login`

A control that lets users enter their username and password.

If your application needs to authenticate the end user, you can use the login control that provides the username/password input fields pair, ready to use.

This control stands on its own on an authentication page, and the application should navigate to another page when the user has entered his user and password information (or canceled the input).

Properties¶

Name	Type	Default	Description
`title`^(★)	`str`	"Log in"	The title of the login dialog.
`on_action`	`Callback`		The name of the function that is triggered when the dialog button is pressed. All the parameters of that function are optional: state (`State`): the state instance. id (str): the identifier of the button. payload (dict): the details on this callback's invocation. This dictionary has the following keys: action: the name of the action that triggered this callback. args: a list with three elements: The first element is the username The second element is the password The third element is the current page name When the button is pressed, and if this property is not set, Taipy will try to find a callback function called on_login() and invoke it with the parameters listed above.
`message`	`str` dynamic		The message shown in the dialog.
`id`	`str`		The identifier that will be assigned to the rendered HTML component.
`properties`	`dict[str, any]`		Bound to a dictionary that contains additional properties for this element.
`class_name`	`str` dynamic		The list of CSS class names that will be associated with the generated HTML Element. These class names will be added to the default `taipy-<element_type>`.
`hover_text`	`str` dynamic		The information that is displayed when the user hovers over this element.

^(★)title is the default property for this visual element.

Details¶

If the user presses the 'Close' button (the cross at the top-right corner of the control), the on_action callback is invoked with the two first elements of the array payload.args (representing the input username and password) set to None.
This is how the application can know whether the user tried to provide the username and password or if the authentication was canceled.

Using the Taipy Enterprise edition

If your application uses the Enterprise edition of Taipy, you can invoke the function taipy.enterprise.gui.login() with the appropriate field to authenticate your session.

Styling¶

All the login controls are generated with the "taipy-login" CSS class. You can use this class name to select the login controls and apply style.

Usage¶

Typical use¶

You create a login control in a page to check for the user's credentials and navigate to the appropriate page afterward.

The control definition can be as simple as:

Definition

MarkdownHTMLPython

<|Welcome to Taipy!|login|>

<taipy:login>Welcome to Taipy!</taipy:login>

import taipy.gui.builder as tgb
...
tgb.login("Welcome to Taipy!")

With this control, the page will look like this:

Login control after username and password were provided

You may improve on the following simple code to implement what to do when users interact with this control:

def on_login(state: State, id, login_args):
    username, password = login_args["args"][:2]
    if username is None: # The user canceled the login request
        return navigate(s, "anonymous")

    # Check whether the username/password is a valid pair
    # Using Taipy Enterprise edition, you could use:
    #   credentials = taipy.enterprise.gui.login(state, username, password)
    ...

    #     # Store the username in the state
    state.username = username
    navigate(s, "authenticated")

If the user closes the control, the application opens the anonymous page.
Otherwise, the authenticated page opens, and the state has stored the username.