1
0
mirror of https://github.com/bitwarden/browser synced 2026-01-09 03:53:53 +00:00
Files
browser/libs/auth/src/angular/registration/registration-start/registration-start.mdx
Jared Snider 215bbc2f8e Auth/PM-7324 - Registration with Email Verification - Registration Start Component Implementation (#9573)
* PM-7324 - Register new registration start comp at signup route on web

* PM-7324 - Add registerSendVerificationEmail logic in API service layer.

* PM-7324 - Update registration start comp to actually send information to API and trigger email.

* PM-7324 - progress on opt in for marketing emails redesign.

* PM-7324 - Add feature flag and feature flag guard to sign up route.

* PM-7324 - RegistrationEnvSelector - emit initial value

* PM-7324 - Registration Start comp - wire up setReceiveMarketingEmailsByRegion logic.

* PM-7324 - Registration start html - use proper link for email pref management.

* PM-7324 - Translate text

* PM-7324 - Design pass

* PM-7324 - design pass v2

* PM-7324 - Update Tailwind config to add availability of anon layout to desktop and browser extension

* PM-7324 - Desktop - AppRoutingModule - Add new signup route protected by the email verification feature flag.

* PM-7324 - BrowserExtension - AppRoutingModule - Add signup route protected by feature flag

* PM-7324 - Feature flag all register page navigations to redirect users to the new signup page.

* PM-7324 - Update AnonLayoutWrapperComponent constructor logic to avoid passing undefined values into I18nService.t method

* PM-7324 - Accept org invite web comp - adjust register url and qParams

* PM-7324 - Add AnonLayoutWrapperData to desktop & browser since we don't need titleId.

* PM-7324 - Revert anon layout wrapper comp changes as they were made separately and merged to main.

* PM-7234 - Fix registration start component so the login route works for the browser extension.

* PM-7324 - Registration start story now building again + fix storybook warning around BrowserAnimationsModule

* PM-7324 - Registration Start - add missing tw-text-main to fix dark mode rendering.

* PM-7324 - Update storybook docs

* PM-7324 - Get stub of registration finish component so that the verify email has something to land on.

* PM-7324 - Registration start - receive marketing materials should never be required.

* PM-7324 - Add finish signup route + required translations to desktop & browser.

* PM-7324 - AnonLayoutWrapperComponent - Resolve issues where navigating to a sibling anonymous route wouldn't update the AnonLayoutWrapperData.

* PM-7324 - Remove unnecessary array

* PM-7324  - Per PR feedback, improve setReceiveMarketingEmailsByRegion

* PM-7324 - Per PR feedback, inject login routes via route data

* PM-7324 - Document methods in account api service

* PM-7324 - PR feedback - jsdoc tweaks
2024-06-14 11:40:56 -04:00

84 lines
2.4 KiB
Plaintext

import { Meta, Story, Controls } from "@storybook/addon-docs";
import * as stories from "./registration-start.stories";
<Meta of={stories} />
# RegistrationStart Component
The Auth-owned RegistrationStartComponent is to be used for the first step in the new email
verification stage gated registration process. It collects the environment (required), the user's
email address (required) and optionally their name. On cloud environments, it offers a checkbox for
the user to choose to receive marketing emails or not with the default value changing based on the
environment (e.g., true for US, false for EU).
## Web Examples
Note that the self hosted option is not present in the environment selector.
### US Region
<Story of={stories.WebUSRegionExample} />
### EU Region
<Story of={stories.WebEURegionExample} />
### Query Params
The component accepts two query parameters: `email` and `emailReadonly`. If an email is provided, it
will be pre-filled in the email input field. If `emailReadonly` is set to `true`, the email input
field will be set to readonly. `emailReadonly` is primarily for the organization invite flow.
<Story of={stories.WebUSRegionQueryParamsExample} />
## Desktop
Behavior to note:
- The self hosted option is present in the environment selector.
- If you go from non-self hosted to self hosted, the receive marketing emails checkbox will
disappear.
- If you change regions, the receive marketing emails checkbox default value will change based on
the region.
### US Region
<Story of={stories.DesktopUSRegionExample} />
### EU Region
<Story of={stories.DesktopEURegionExample} />
### Self Hosted
Note the fact that the receive marketing emails checkbox is not present when the environment is self
hosted.
<Story of={stories.DesktopSelfHostExample} />
## Browser Extension
Behavior to note:
- The self hosted option is present in the environment selector.
- If you go from non-self hosted to self hosted, the receive marketing emails checkbox will
disappear.
- If you change regions, the receive marketing emails checkbox default value will change based on
the region.
### US Region
<Story of={stories.BrowserExtensionUSRegionExample} />
### EU Region
<Story of={stories.BrowserExtensionEURegionExample} />
### Self Hosted
Note the fact that the receive marketing emails checkbox is not present when the environment is self
hosted.
<Story of={stories.BrowserExtensionSelfHostExample} />