2025-04-18 19:19:20 +02:00
|
|
|
---
|
|
|
|
title: Account
|
|
|
|
---
|
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
import { DocusaurusDoc } from '@freesewing/react/components/Docusaurus'
|
|
|
|
import { ComponentDocs } from '@site/src/components/component-docs.js'
|
2025-05-09 17:47:03 +02:00
|
|
|
import { MiniNote } from '@freesewing/react/components/Mini'
|
2025-05-09 17:46:51 +02:00
|
|
|
import {
|
|
|
|
jsdocAccountStatus as jsdocAccount,
|
|
|
|
jsdocAccountStatus,
|
|
|
|
jsdocApikeys,
|
|
|
|
jsdocAvatar,
|
|
|
|
jsdocBio,
|
|
|
|
jsdocBookmarkButton,
|
|
|
|
jsdocBookmarks,
|
|
|
|
jsdocCompare,
|
|
|
|
jsdocConsent,
|
|
|
|
jsdocControl,
|
|
|
|
jsdocEmail,
|
|
|
|
jsdocEmailChangeConfirmation,
|
|
|
|
jsdocExport,
|
|
|
|
jsdocGithub,
|
|
|
|
jsdocImportSet,
|
|
|
|
jsdocInstagram,
|
|
|
|
jsdocLinks,
|
|
|
|
jsdocMastodon,
|
|
|
|
jsdocMfa,
|
|
|
|
jsdocMsetCard,
|
|
|
|
jsdocNewSet,
|
|
|
|
jsdocNewsletter,
|
2025-05-09 17:47:03 +02:00
|
|
|
jsdocPassword,
|
|
|
|
jsdocPattern,
|
|
|
|
jsdocPatternCard,
|
|
|
|
jsdocPatterns,
|
|
|
|
jsdocReddit,
|
|
|
|
jsdocReload,
|
|
|
|
jsdocRemove,
|
|
|
|
jsdocRestrict,
|
|
|
|
jsdocSet,
|
|
|
|
jsdocSets,
|
|
|
|
jsdocTiktok,
|
|
|
|
jsdocTwitch,
|
|
|
|
jsdocUnits,
|
|
|
|
jsdocUserId,
|
|
|
|
jsdocUsername,
|
|
|
|
jsdocUserRole,
|
|
|
|
jsdocWebsite,
|
2025-05-09 17:46:51 +02:00
|
|
|
} from '@site/prebuild/jsdoc/components.account.mjs'
|
|
|
|
import {
|
|
|
|
AccountStatusExample,
|
|
|
|
ApikeysExample,
|
|
|
|
AvatarExample,
|
|
|
|
BioExample,
|
|
|
|
BookmarkButtonExample,
|
|
|
|
BookmarksExample,
|
|
|
|
CompareExample,
|
|
|
|
ConsentExample,
|
|
|
|
ControlExample,
|
|
|
|
EmailExample,
|
|
|
|
EmailChangeConfirmationExample,
|
|
|
|
ExportExample,
|
|
|
|
GithubExample,
|
|
|
|
ImportSetExample,
|
|
|
|
InstagramExample,
|
|
|
|
LinksExample,
|
|
|
|
MastodonExample,
|
|
|
|
MfaExample,
|
|
|
|
MsetCardExample,
|
|
|
|
NewSetExample,
|
|
|
|
NewsletterExample,
|
2025-05-09 17:47:03 +02:00
|
|
|
PasswordExample,
|
|
|
|
PatternExample,
|
|
|
|
PatternCardExample,
|
|
|
|
PatternsExample,
|
|
|
|
RedditExample,
|
|
|
|
ReloadExample,
|
|
|
|
RemoveExample,
|
|
|
|
RestrictExample,
|
|
|
|
SetExample,
|
|
|
|
SetsExample,
|
|
|
|
TiktokExample,
|
|
|
|
TwitchExample,
|
|
|
|
UnitsExample,
|
|
|
|
UserIdExample,
|
|
|
|
UsernameExample,
|
|
|
|
UserRoleExample,
|
|
|
|
WebsiteExample,
|
2025-05-09 17:46:51 +02:00
|
|
|
} from './_examples.js'
|
|
|
|
|
|
|
|
<DocusaurusDoc>
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
- [Components](#components)
|
|
|
|
|
|
|
|
## Components
|
|
|
|
|
|
|
|
The **Account** component family provides the following [components](#components):
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
- [AccountStatus ](#accountstatus)
|
|
|
|
- [Apikeys ](#apikeys)
|
|
|
|
- [Avatar ](#avatar)
|
|
|
|
- [Bio ](#bio)
|
|
|
|
- [BookmarkButton ](#bookmarkbutton)
|
|
|
|
- [Bookmarks ](#bookmarks)
|
|
|
|
- [Compare ](#compare)
|
|
|
|
- [Consent ](#consent)
|
|
|
|
- [Control ](#control)
|
|
|
|
- [Email ](#email)
|
2025-05-09 17:46:51 +02:00
|
|
|
- [EmailChangeConfirmation](#emailchanfirmation)
|
2025-05-09 17:47:03 +02:00
|
|
|
- [Export ](#export)
|
|
|
|
- [Github ](#github)
|
|
|
|
- [ImportSet ](#importset)
|
|
|
|
- [Instagram ](#instagram)
|
|
|
|
- [Links ](#links)
|
|
|
|
- [Mastodon ](#mastodon)
|
|
|
|
- [Mfa ](#mfa)
|
|
|
|
- [MsetCard ](#msetcard)
|
|
|
|
- [NewSet ](#newset)
|
|
|
|
- [Newsletter ](#newslett)
|
|
|
|
- [Password ](#password)
|
|
|
|
- [Pattern ](#pattern)
|
|
|
|
- [PatternCard ](#patterncard)
|
|
|
|
- [Patterns ](#patterns)
|
|
|
|
- [Reddit ](#reddit)
|
|
|
|
- [Reload ](#reload)
|
|
|
|
- [Remove ](#remove)
|
|
|
|
- [Restrict ](#restrict)
|
|
|
|
- [Set ](#set)
|
|
|
|
- [Sets ](#sets)
|
|
|
|
- [Tiktok ](#tiktok)
|
|
|
|
- [Twitch ](#twitch)
|
|
|
|
- [Units ](#units)
|
|
|
|
- [UserId ](#userid)
|
|
|
|
- [Username ](#username)
|
|
|
|
- [UserRole ](#userrole)
|
|
|
|
- [Website ](#website)
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### AccountStatus
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocAccountStatus} example={AccountStatusExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Apikeys
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocApikeys} example={ApikeysExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Avatar
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocAvatar} example={AvatarExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Bio
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocBio} example={BioExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### BookmarkButton
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocBookmarkButton} example={BookmarkButtonExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Bookmarks
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocBookmarks} example={BookmarksExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Compare
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocCompare} example={CompareExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Consent
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocConsent} example={ConsentExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Control
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocControl} example={ControlExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Email
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocEmail} example={EmailExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### EmailChangeConfirmation
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<MiniNote>
|
2025-05-09 17:47:03 +02:00
|
|
|
#### Requires a valid callback URL This component will not work without the proper <code>id</code>{' '}
|
|
|
|
and <code>check</code> URL paramters that come from a email confirmation link sent out from the
|
|
|
|
FreeSewing backend.
|
2025-05-09 17:46:51 +02:00
|
|
|
</MiniNote>
|
|
|
|
|
|
|
|
<ComponentDocs docs={jsdocEmailChangeConfirmation} example={EmailChangeConfirmationExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Export
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocExport} example={ExportExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Github
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocGithub} example={GithubExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### ImportSet
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocImportSet} example={ImportSetExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Instagram
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocInstagram} example={InstagramExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Links
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocLinks} example={LinksExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Mastodon
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocMastodon} example={MastodonExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Mfa
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocMfa} example={MfaExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### MsetCard
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocMsetCard} example={MsetCardExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### NewSet
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocNewSet} example={NewSetExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Newsletter
|
2025-05-09 17:47:03 +02:00
|
|
|
|
2025-05-09 17:46:51 +02:00
|
|
|
<ComponentDocs docs={jsdocNewsletter} example={NewsletterExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Password
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocPassword} example={PasswordExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Pattern
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocPattern} example={PatternExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### PatternCard
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocPatternCard} example={PatternCardExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Patterns
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocPatterns} example={PatternsExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Reddit
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocReddit} example={RedditExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Reload
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocReload} example={ReloadExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Remove
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocRemove} example={RemoveExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Restrict
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocRestrict} example={RestrictExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Set
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocSet} example={SetExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Sets
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocSets} example={SetsExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Tiktok
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocTiktok} example={TiktokExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Twitch
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocTwitch} example={TwitchExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Units
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocUnits} example={UnitsExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### UserId
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocUserId} example={UserIdExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Username
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocUsername} example={UsernameExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### UserRole
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocUserRole} example={UserRoleExample} />
|
|
|
|
|
2025-05-25 16:29:57 +02:00
|
|
|
### Website
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
<ComponentDocs docs={jsdocWebsite} example={WebsiteExample} />
|
2025-05-09 17:46:51 +02:00
|
|
|
|
2025-05-09 17:47:03 +02:00
|
|
|
</DocusaurusDoc>
|