Skip to content

Commit 5686eea

Browse files
BcnCarloslrzhou25
BcnCarlos
and
lrzhou25
authored
Fix/docs 5320 acul js sdk signup (#427)
* Update Login.mdx * Update LoginEmailVerification.mdx * Update Login.mdx * Update LoginEmailVerification.mdx * Update LoginId.mdx * Update LoginPassword.mdx * Update LoginPasswordlessEmailCode.mdx * Update LoginPasswordlessSmsOtp.mdx * Update Logout.mdx * Update Signup.mdx * Update Signup.mdx * Update SignupId.mdx * Update SignupPassword.mdx * Update SignupId.mdx * Update Signup.mdx * Update Signup.mdx * Update main/docs/libraries/acul/js-sdk/Screens/classes/LoginPassword.mdx Co-authored-by: Lucy Zhou <[email protected]> * Update main/docs/libraries/acul/js-sdk/Screens/classes/SignupId.mdx Co-authored-by: Lucy Zhou <[email protected]> * Update main/docs/libraries/acul/js-sdk/Screens/classes/SignupId.mdx Co-authored-by: Lucy Zhou <[email protected]> * Update main/docs/libraries/acul/js-sdk/Screens/classes/LoginId.mdx Co-authored-by: Lucy Zhou <[email protected]> * Update main/docs/libraries/acul/js-sdk/Screens/classes/LoginEmailVerification.mdx Co-authored-by: Lucy Zhou <[email protected]> --------- Co-authored-by: Lucy Zhou <[email protected]>
1 parent 3466623 commit 5686eea

File tree

10 files changed

+311
-251
lines changed

10 files changed

+311
-251
lines changed

‎main/docs/libraries/acul/js-sdk/Screens/classes/Login.mdx‎

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Login class implements the `login` screen functionality. This screen collect
88

99
## Constructors
1010

11-
Creates an instance of Login screen manager
11+
Create an instance of Login screen manager
1212

1313
```ts Example
1414
import Login from "@auth0/auth0-acul-js/login";
@@ -22,7 +22,7 @@ loginManager.login({
2222
## Properties
2323

2424
<ParamField body='branding' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}>
25-
Provides branding-related configurations, such as theme settings for the `login` screen.
25+
Provides branding-related configurations, such as branding theme and settings.
2626
</ParamField>
2727

2828
<ParamField body='client' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}>
@@ -77,11 +77,11 @@ loginManager.federatedLogin({
7777
<Expandable title="Parameters">
7878

7979
<ParamField body='connection' type='string' required>
80-
The social connection name to use
80+
The social connection name to use.
8181
</ParamField>
8282

8383
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
84-
The authentication transaction state
84+
Additional data collected from the user.
8585
</ParamField>
8686

8787
</Expandable>
@@ -120,7 +120,7 @@ The captcha code or response from the captcha provider. This property is require
120120
</ParamField>
121121

122122
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
123-
The authentication transaction state
123+
Additional data collected from the user.
124124
</ParamField>
125125

126126
</Expandable>
@@ -142,7 +142,7 @@ loginManager.pickCountryCode();
142142

143143
<Expandable title="Parameters">
144144
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
145-
The authentication transaction state
145+
Additional data collected from the user.
146146
</ParamField>
147147

148148
</Expandable>
@@ -151,21 +151,14 @@ The authentication transaction state
151151

152152
<ParamField body='getErrors' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>
153153

154-
Retrieves the array of transaction errors from the context, or an empty array if none exist.
155-
156-
An array of error objects from the transaction context.
154+
This method retrieves the array of transaction errors from the context, or an empty array if none exist. An array of error objects from the transaction context.
157155

158156
</ParamField>
159157

160-
---
161158

162159
<ParamField body='getLoginIdentifiers' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/type-aliases/ScreenIdentifierType">ScreenIdentifierType</a>[]</span>}>
163160

164-
**`Utility Feature`**
165-
166-
Gets the active identifier types for the login screen
167-
168-
An array of active identifier types or null if none are active
161+
This method lets the active identifier types for the login screen. An array of active identifier types or `null` if none are active
169162

170163
```typescript Example
171164
import Login from "@auth0/auth0-acul-js/login";

‎main/docs/libraries/acul/js-sdk/Screens/classes/LoginEmailVerification.mdx‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ to verify their identity during the login process.
1010

1111
## Constructors
1212

13-
Creates an instance of LoginEmailVerification screen manager
13+
Create an instance of LoginEmailVerification screen manager
1414

1515
```typescript Example
1616
// How to use the LoginEmailVerification screen SDK:
@@ -24,11 +24,11 @@ const loginEmailVerificationManager = new LoginEmailVerification();
2424
## Properties
2525

2626
<ParamField body='branding' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}>
27-
Provides branding-related configurations, such as theme settings for the `login-email-verification` screen.
27+
Provides branding-related configurations, such as branding theme and settings.
2828
</ParamField>
2929

3030
<ParamField body='client' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}>
31-
Provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `login-email-verification`screen.
31+
Provides client-related configurations, such as `id`, `name`, and `logoUrl`.
3232
</ParamField>
3333

3434
<ParamField body='organization' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}>
@@ -88,7 +88,7 @@ or alphanumeric string that the user must enter into the form.
8888
</ParamField>
8989

9090
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
91-
The authentication transaction state
91+
Additional data collected from the user.
9292
</ParamField>
9393

9494
</Expandable>
@@ -120,7 +120,7 @@ manager.resendCode()
120120
<Expandable title="Parameters">
121121

122122
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
123-
The authentication transaction state
123+
Additional data collected from the user.
124124
</ParamField>
125125

126126
</Expandable>
@@ -129,7 +129,7 @@ The authentication transaction state
129129

130130
<ParamField body='resendManager' type='(options ?)'/>
131131

132-
This method resends functionality with timeout management for this screen
132+
This method gets resend functionality with timeout management for this screen.
133133

134134
```typescript Example
135135
import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
@@ -153,7 +153,9 @@ startResend();
153153

154154
<Expandable title="Parameters">
155155

156-
<ParamField body='onStatusChange?' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/type-aliases/OnStatusChangeCallback">OnStatusChangeCallback</a></span>}/>
156+
<ParamField body='onStatusChange?' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/type-aliases/OnStatusChangeCallback">OnStatusChangeCallback</a></span>}>
157+
Callback function for status changes during resend countdown.
158+
</ParamField>
157159

158160
<ParamField body='onTimeout' type='void'/>
159161

@@ -165,8 +167,6 @@ startResend();
165167

166168
<ParamField body='getErrors' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>
167169

168-
Retrieves the array of transaction errors from the context, or an empty array if none exist.
169-
170-
An array of error objects from the transaction context.
170+
This method retrieves the array of transaction errors from the context, or an empty array if none exist. An array of error objects from the transaction context.
171171

172172
</ParamField>

‎main/docs/libraries/acul/js-sdk/Screens/classes/LoginId.mdx‎

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ loginIdManager.getLoginIdentifiers();
1818
## Properties
1919

2020
<ParamField body='branding' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}>
21-
Provides branding-related configurations, such as theme settings for the `login-id` screen.
21+
Provides branding-related configurations, such as branding theme and settings.
2222
</ParamField>
2323

2424
<ParamField body='client' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}>
@@ -84,25 +84,21 @@ loginIdManager.federatedLogin({
8484

8585
**Method Parameters**
8686

87-
<ParamField body='options' type='OPTIONAL'>
88-
An object containing the necessarty parameters for selecting a specific social connection for login.
89-
</ParamField>
90-
9187
<Expandable title="Parameters">
9288

9389
<ParamField body='connection' type='string' required>
9490
The social connection name to use
9591
</ParamField>
9692

9793
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
98-
The authentication transaction state
94+
Additional data collected from the user.
9995
</ParamField>
10096

10197
</Expandable>
10298

10399
---
104100

105-
<ParamField body='login' type='OPTIONAL'/>
101+
<ParamField body='login' type='(options ?)'/>
106102

107103
This method prompts the user to provide their username.
108104

@@ -129,7 +125,7 @@ The captcha code or response from the captcha provider. This property is require
129125
</ParamField>
130126

131127
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
132-
The authentication transaction state
128+
Additional data collected from the user.
133129
</ParamField>
134130

135131
</Expandable>
@@ -153,7 +149,7 @@ loginIdManager.passkeyLogin();
153149
<Expandable title="Parameters">
154150

155151
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
156-
The authentication transaction state
152+
Additional data collected from the user.
157153
</ParamField>
158154

159155
</Expandable>
@@ -175,16 +171,16 @@ loginIdManager.pickCountryCode();
175171

176172
<Expandable title="Parameters">
177173
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
178-
The authentication transaction state
174+
Additional data collected from the user.
179175
</ParamField>
180176

181177
</Expandable>
182178

183179
---
184180

185-
<ParamField body='registerPasskeyAutofill' type='(inputId?: string)'>
181+
<ParamField body='registerPasskeyAutofill' type='(inputId?: string)'/>
186182

187-
Registers the browser's Conditional UI for passkeys (autocomplete experience).
183+
This method registers the browser's Conditional UI for passkeys (autocomplete experience).
188184

189185
This method initializes a passive WebAuthn credential request using
190186
`navigator.credentials.get()` with `mediation: "conditional"`. When supported,
@@ -195,7 +191,21 @@ Call this **once** when the login screen is initialized (for example, on page lo
195191
After registration, focusing the username input will automatically display
196192
matching passkeys as suggestions. Selecting a passkey completes authentication
197193
without requiring additional user interaction.
198-
</ParamField>
194+
195+
```ts Example
196+
import LoginId from '@auth0/auth0-acul-js/login-id';
197+
198+
// Example: initializing passkey autocomplete inside an async setup block.
199+
async function initializeLogin() {
200+
const loginId = new LoginId();
201+
// Make sure associated HTML input exists:
202+
// <input id="username" autocomplete="webauthn username" />
203+
// Conditional UI registration.
204+
await loginId.registerPasskeyAutofill('username');
205+
}
206+
207+
initializeLogin().catch(console.error);
208+
```
199209

200210
**Input configuration**
201211
If an `inputId` is provided, the SDK will:
@@ -221,27 +231,16 @@ the input element manually with the correct attributes:
221231

222232
**Method Parameters**
223233

234+
<Expandable title="Parameters">
235+
224236
<ParamField body='inputId?' type='string'>
225-
`string`
226237

227238
Optional ID of the username `<input>` element (without `#`). Example: `"username"`.
228239
If omitted, the developer must manually ensure the correct `autocomplete` attributes.
229240
</ParamField>
230241

231-
```ts Example
232-
import LoginId from '@auth0/auth0-acul-js/login-id';
233-
234-
// Example: initializing passkey autocomplete inside an async setup block.
235-
async function initializeLogin() {
236-
const loginId = new LoginId();
237-
// Make sure associated HTML input exists:
238-
// <input id="username" autocomplete="webauthn username" />
239-
// Conditional UI registration.
240-
await loginId.registerPasskeyAutofill('username');
241-
}
242+
</Expandable>
242243

243-
initializeLogin().catch(console.error);
244-
```
245244

246245
**Remarks**
247246

@@ -253,16 +252,15 @@ only be invoked once per page lifecycle.
253252

254253
<ParamField body='getErrors' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>
255254

256-
Retrieves the array of transaction errors from the context, or an empty array if none exist.
255+
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
257256

258257
</ParamField>
259258

260-
---
261259

262260
<ParamField body='getLoginIdentifiers' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/type-aliases/ScreenIdentifierType">ScreenIdentifierType</a>[]</span>}>
263261

264262

265-
Gets the active identifier types for the login screen
263+
This method gets the active identifier types for the login screen.
266264

267265
```typescript Example
268266
import LoginId from "@auth0/auth0-acul-js/login";

‎main/docs/libraries/acul/js-sdk/Screens/classes/LoginPassword.mdx‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The LoginPassword class implements the `login-password` screen functionality. Th
88

99
## Constructors
1010

11-
Creates an instance of LoginPassword screen manager
11+
Create an instance of LoginPassword screen manager
1212

1313
```ts Example
1414
import LoginPassword from "@auth0/auth0-acul-js/login-password";
@@ -22,11 +22,11 @@ loginPasswordManager.login({
2222
## Properties
2323

2424
<ParamField body='branding' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}>
25-
Provides branding-related configurations, such as theme settings for the `login-password` screen.
25+
Provides branding-related configurations, such as branding theme and settings.
2626
</ParamField>
2727

2828
<ParamField body='client' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}>
29-
Provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `login-password` screen.
29+
Provides client-related configurations, such as `id`, `name`, and `logoUrl`.
3030
</ParamField>
3131

3232
<ParamField body='organization' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}>
@@ -89,11 +89,11 @@ loginIdManager.federatedLogin({
8989
<Expandable title="Parameters">
9090

9191
<ParamField body='connection' type='string' required>
92-
The social connection name to use
92+
The social connection name to use.
9393
</ParamField>
9494

9595
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
96-
The authentication transaction state
96+
Additional data collected from the user.
9797
</ParamField>
9898

9999
</Expandable>
@@ -129,7 +129,7 @@ The captcha code or response from the captcha provider. This property is require
129129
</ParamField>
130130

131131
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
132-
The authentication transaction state
132+
Additional data collected from the user.
133133
</ParamField>
134134

135135
</Expandable>
@@ -160,11 +160,11 @@ handleSwitchConnection('sms'); // Switch to SMS-based authentication
160160
<Expandable title="Parameters">
161161

162162
<ParamField body='connection' type='string' required>
163-
The social connection name to use
163+
The social connection name to use.
164164
</ParamField>
165165

166166
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
167-
The authentication transaction state
167+
Additional data collected from the user.
168168
</ParamField>
169169

170170
</Expandable>
@@ -173,8 +173,6 @@ The authentication transaction state
173173

174174
<ParamField body='getErrors' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>
175175

176-
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
177-
178-
An array of error objects from the transaction context.
176+
This method retrieves the array of transaction errors from the context, or an empty array if none exist. An array of error objects from the transaction context.
179177

180178
</ParamField>

‎main/docs/libraries/acul/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,7 @@ Details of the active user, including `username`, `email`, and `roles`.
7070

7171
<ParamField body='getErrors' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>
7272

73-
Retrieves the array of transaction errors from the context, or an empty array if none exist.
74-
75-
An array of error objects from the transaction context.
73+
This method retrieves the array of transaction errors from the context, or an empty array if none exist. An array of error objects from the transaction context.
7674

7775
</ParamField>
7876

@@ -93,7 +91,7 @@ loginPasswordlessEmailCode.resendCode();
9391
<Expandable title="Parameters">
9492

9593
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
96-
The authentication transaction state
94+
Additional data collected from the user.
9795
</ParamField>
9896

9997
</Expandable>
@@ -165,11 +163,9 @@ The code entered by the user.
165163
</ParamField>
166164

167165
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"'>
168-
The authentication transaction state
166+
Additional data collected from the user.
169167
</ParamField>
170168

171-
Additional data collected from the user.
172-
173169
</Expandable>
174170

175171
---

0 commit comments

Comments
 (0)