Praxxme.IdConstants

A .NET library for generating data-testid identifiers for HTML elements.

Components

HtmlElementType Enum

Defines the type of HTML elements. Includes standard HTML elements (div, input, button) as well as custom types (Dropdown, DropdownItem) to provide better context.

IdRoles.resx

A resource file containing unique string descriptions of element purposes in the application.

Examples:

• PrescriptionUpload_GoBackToImageCapturing: prescription-upload-go-back-to-image-capturing
• NavigationMenu_AppointmentsBooking: navigation-menu-appointments-booking
• DataForm_DateOfBirth: data-form-enter-date-of-birth

IdBuilder Class

Bundles everything together with the CreateId method. The generated ID follows this format (converted to lowercase): {HtmlElementType}--{Role}[--{AdditionalLabel}]

Note: The {AdditionalLabel} string is sanitized by converting to lowercase, converting "ä, ü, ö, ß" to "ae, ue, oe, ss", and removing all non-letter and non-number characters(except "-") using the following regular expression: "[^a-z0-9\-]"

Example Usage

    IdBuilder.CreateId(HtmlElementType.Input, IdRoles.PraxisSelection_FilterByText)

creates

    input--praxis-selection-filter-praxises-by-text

    IdBuilder.CreateId(HtmlElementType.Button, IdRoles.PraxisSelection_SelectPraxis, Id.ToString())

creates

    button--praxis-selection-select-praxis--3153cfd0-c30b-4a27-bc30-55f9e73a4e95