{ "timestamp": "2022-10-27T21:04:43", "compiler": { "name": "@stencil/core", "version": "1.15.0", "typescriptVersion": "3.9.5" }, "components": [ { "filePath": "./src/components/amplify-amazon-button/amplify-amazon-button.tsx", "encapsulation": "shadow", "tag": "amplify-amazon-button", "readme": "# amplify-amazon-button\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "clientId", "type": "string", "mutable": false, "attr": "client-id", "reflectToAttr": false, "docs": "App-specific client ID from Google", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this component\ne.g. SignIn -> 'Create Account' link -> SignUp", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-federated-buttons" ], "dependencies": [ "amplify-sign-in-button" ], "dependencyGraph": { "amplify-amazon-button": [ "amplify-sign-in-button" ], "amplify-sign-in-button": [ "amplify-icon" ], "amplify-federated-buttons": [ "amplify-amazon-button" ] } }, { "filePath": "./src/components/amplify-auth-container/amplify-auth-container.tsx", "encapsulation": "none", "tag": "amplify-auth-container", "readme": "# amplify-auth-container\n\n\n", "docs": "", "docsTags": [ { "text": "(default) - Content placed within the container", "name": "slot" } ], "usage": {}, "props": [], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "(default)", "docs": "Content placed within the container" } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/amplify-auth-fields/amplify-auth-fields.tsx", "encapsulation": "none", "tag": "amplify-auth-fields", "readme": "# amplify-auth-fields\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "formFields", "type": "FormFieldTypes | string[]", "mutable": false, "reflectToAttr": false, "docs": "Form fields allows you to utilize our pre-built components such as username field, code field, password field, email field, etc.\nby passing an array of strings that you would like the order of the form to be in. If you need more customization, such as changing\ntext for a label or adjust a placeholder, you can follow the structure below in order to do just that.\n```\n[\n {\n type: string,\n label: string,\n placeholder: string,\n hint: string | Functional Component | null,\n required: boolean\n }\n]\n```", "docsTags": [], "values": [ { "type": "FormFieldTypes" }, { "type": "string[]" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-confirm-sign-in", "amplify-confirm-sign-up", "amplify-forgot-password", "amplify-require-new-password", "amplify-sign-in", "amplify-sign-up" ], "dependencies": [ "amplify-username-field", "amplify-password-field", "amplify-email-field", "amplify-code-field", "amplify-phone-field", "amplify-form-field" ], "dependencyGraph": { "amplify-auth-fields": [ "amplify-username-field", "amplify-password-field", "amplify-email-field", "amplify-code-field", "amplify-phone-field", "amplify-form-field" ], "amplify-username-field": [ "amplify-form-field" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-password-field": [ "amplify-form-field" ], "amplify-email-field": [ "amplify-form-field" ], "amplify-code-field": [ "amplify-form-field" ], "amplify-phone-field": [ "amplify-form-field", "amplify-country-dial-code", "amplify-input" ], "amplify-country-dial-code": [ "amplify-select" ], "amplify-confirm-sign-in": [ "amplify-auth-fields" ], "amplify-confirm-sign-up": [ "amplify-auth-fields" ], "amplify-forgot-password": [ "amplify-auth-fields" ], "amplify-require-new-password": [ "amplify-auth-fields" ], "amplify-sign-in": [ "amplify-auth-fields" ], "amplify-sign-up": [ "amplify-auth-fields" ] } }, { "filePath": "./src/components/amplify-auth0-button/amplify-auth0-button.tsx", "encapsulation": "shadow", "tag": "amplify-auth0-button", "readme": "# amplify-auth0-button\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "config", "type": "{ audience?: string; clientID: string; domain: string; responseType: string; redirectUri: string; returnTo?: string; scope?: string; }", "mutable": false, "reflectToAttr": false, "docs": "See: https://auth0.com/docs/libraries/auth0js/v9#available-parameters", "docsTags": [], "values": [ { "type": "{ audience?: string; clientID: string; domain: string; responseType: string; redirectUri: string; returnTo?: string; scope?: string; }" } ], "optional": false, "required": false }, { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this component", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-federated-buttons" ], "dependencies": [ "amplify-sign-in-button" ], "dependencyGraph": { "amplify-auth0-button": [ "amplify-sign-in-button" ], "amplify-sign-in-button": [ "amplify-icon" ], "amplify-federated-buttons": [ "amplify-auth0-button" ] } }, { "filePath": "./src/components/amplify-authenticator/amplify-authenticator.tsx", "encapsulation": "shadow", "tag": "amplify-authenticator", "readme": "# amplify-authenticator\n", "docs": "", "docsTags": [ { "text": "sign-in - Content placed inside of the sign in workflow for when a user wants to sign into their account", "name": "slot" }, { "text": "confirm-sign-in - Content placed inside of the confirm sign in workflow for when a user needs to confirm the account they signed in with", "name": "slot" }, { "text": "sign-up - Content placed inside of the sign up workflow for when a user wants to register a new account", "name": "slot" }, { "text": "confirm-sign-up - Content placed inside of the confirm sign up workflow for when a user needs to confirm the account they signed up with", "name": "slot" }, { "text": "forgot-password - Content placed inside of the forgot password workflow for when a user wants to reset their password", "name": "slot" }, { "text": "require-new-password - Content placed inside of the require new password workflow for when a user is required to update their password", "name": "slot" }, { "text": "verify-contact - Content placed inside of the verify-contact workflow for when a user must verify their contact information", "name": "slot" }, { "text": "totp-setup - Content placed inside of the totp-setup workflow for when a user opts to use TOTP MFA", "name": "slot" }, { "text": "greetings - Content placed inside of the greetings navigation for when a user is signed in", "name": "slot" }, { "text": "loading - Content placed inside of the loading workflow for when the app is loading", "name": "slot" } ], "usage": {}, "props": [ { "name": "federated", "type": "FederatedConfig", "mutable": false, "reflectToAttr": false, "docs": "Federated credentials & configuration.", "docsTags": [], "values": [ { "type": "FederatedConfig" } ], "optional": false, "required": false }, { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Callback for Authenticator state machine changes", "docsTags": [], "default": "() => {}", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false }, { "name": "hideToast", "type": "boolean", "mutable": false, "attr": "hide-toast", "reflectToAttr": false, "docs": "Hide amplify-toast for auth errors", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "initialAuthState", "type": "AuthState.ForgotPassword | AuthState.SignIn | AuthState.SignUp", "mutable": false, "attr": "initial-auth-state", "reflectToAttr": false, "docs": "Initial starting state of the Authenticator component. E.g. If `signup` is passed the default component is set to AmplifySignUp", "docsTags": [], "default": "AuthState.SignIn", "values": [ { "type": "AuthState.ForgotPassword" }, { "type": "AuthState.SignIn" }, { "type": "AuthState.SignUp" } ], "optional": false, "required": false }, { "name": "usernameAlias", "type": "\"email\" | \"phone_number\" | \"username\"", "mutable": false, "attr": "username-alias", "reflectToAttr": false, "docs": "Username Alias is used to setup authentication with `username`, `email` or `phone_number`", "docsTags": [], "values": [ { "value": "email", "type": "string" }, { "value": "phone_number", "type": "string" }, { "value": "username", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--background-color", "annotation": "prop", "docs": "Background color of the container" }, { "name": "--border-radius", "annotation": "prop", "docs": "Border radius of the container" }, { "name": "--box-shadow", "annotation": "prop", "docs": "Bow shadow of the container" }, { "name": "--container-align", "annotation": "prop", "docs": "`align-items` property of a flex container" }, { "name": "--container-display", "annotation": "prop", "docs": "Display option of the container. Defaults to flex." }, { "name": "--container-height", "annotation": "prop", "docs": "Height of the container. Defaults to 100vh." }, { "name": "--container-justify", "annotation": "prop", "docs": "`justify-content` property of a flex container" }, { "name": "--margin-bottom", "annotation": "prop", "docs": "Margin below the component" }, { "name": "--min-width", "annotation": "prop", "docs": "Minimum width of the container" }, { "name": "--padding", "annotation": "prop", "docs": "Padding within the component" }, { "name": "--width", "annotation": "prop", "docs": "Width of the container" } ], "slots": [ { "name": "confirm-sign-in", "docs": "Content placed inside of the confirm sign in workflow for when a user needs to confirm the account they signed in with" }, { "name": "confirm-sign-up", "docs": "Content placed inside of the confirm sign up workflow for when a user needs to confirm the account they signed up with" }, { "name": "forgot-password", "docs": "Content placed inside of the forgot password workflow for when a user wants to reset their password" }, { "name": "greetings", "docs": "Content placed inside of the greetings navigation for when a user is signed in" }, { "name": "loading", "docs": "Content placed inside of the loading workflow for when the app is loading" }, { "name": "require-new-password", "docs": "Content placed inside of the require new password workflow for when a user is required to update their password" }, { "name": "sign-in", "docs": "Content placed inside of the sign in workflow for when a user wants to sign into their account" }, { "name": "sign-up", "docs": "Content placed inside of the sign up workflow for when a user wants to register a new account" }, { "name": "totp-setup", "docs": "Content placed inside of the totp-setup workflow for when a user opts to use TOTP MFA" }, { "name": "verify-contact", "docs": "Content placed inside of the verify-contact workflow for when a user must verify their contact information" } ], "parts": [], "dependents": [], "dependencies": [ "amplify-sign-in", "amplify-confirm-sign-in", "amplify-sign-up", "amplify-confirm-sign-up", "amplify-forgot-password", "amplify-require-new-password", "amplify-verify-contact", "amplify-totp-setup", "amplify-toast" ], "dependencyGraph": { "amplify-authenticator": [ "amplify-sign-in", "amplify-confirm-sign-in", "amplify-sign-up", "amplify-confirm-sign-up", "amplify-forgot-password", "amplify-require-new-password", "amplify-verify-contact", "amplify-totp-setup", "amplify-toast" ], "amplify-sign-in": [ "amplify-button", "amplify-form-section", "amplify-federated-buttons", "amplify-strike", "amplify-auth-fields", "amplify-loading-spinner" ], "amplify-button": [ "amplify-icon" ], "amplify-form-section": [ "amplify-section", "amplify-button", "amplify-loading-spinner" ], "amplify-loading-spinner": [ "amplify-icon" ], "amplify-federated-buttons": [ "amplify-google-button", "amplify-facebook-button", "amplify-amazon-button", "amplify-oauth-button", "amplify-auth0-button" ], "amplify-google-button": [ "amplify-sign-in-button" ], "amplify-sign-in-button": [ "amplify-icon" ], "amplify-facebook-button": [ "amplify-sign-in-button" ], "amplify-amazon-button": [ "amplify-sign-in-button" ], "amplify-oauth-button": [ "amplify-sign-in-button" ], "amplify-auth0-button": [ "amplify-sign-in-button" ], "amplify-auth-fields": [ "amplify-username-field", "amplify-password-field", "amplify-email-field", "amplify-code-field", "amplify-phone-field", "amplify-form-field" ], "amplify-username-field": [ "amplify-form-field" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-password-field": [ "amplify-form-field" ], "amplify-email-field": [ "amplify-form-field" ], "amplify-code-field": [ "amplify-form-field" ], "amplify-phone-field": [ "amplify-form-field", "amplify-country-dial-code", "amplify-input" ], "amplify-country-dial-code": [ "amplify-select" ], "amplify-confirm-sign-in": [ "amplify-form-section", "amplify-button", "amplify-auth-fields" ], "amplify-sign-up": [ "amplify-form-section", "amplify-auth-fields", "amplify-button", "amplify-loading-spinner" ], "amplify-confirm-sign-up": [ "amplify-button", "amplify-form-section", "amplify-auth-fields" ], "amplify-forgot-password": [ "amplify-form-section", "amplify-button", "amplify-auth-fields" ], "amplify-require-new-password": [ "amplify-form-section", "amplify-button", "amplify-auth-fields" ], "amplify-verify-contact": [ "amplify-input", "amplify-radio-button", "amplify-form-section", "amplify-button" ], "amplify-radio-button": [ "amplify-label" ], "amplify-totp-setup": [ "amplify-form-section", "amplify-form-field" ], "amplify-toast": [ "amplify-icon" ] } }, { "filePath": "./src/components/amplify-button/amplify-button.tsx", "encapsulation": "none", "tag": "amplify-button", "readme": "# amplify-button\n", "docs": "", "docsTags": [ { "text": "(default) - content placed within the button", "name": "slot" } ], "usage": {}, "props": [ { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "Disabled state of the button", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "handleButtonClick", "type": "(evt: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "(Optional) Callback called when a user clicks on the button", "docsTags": [], "values": [ { "type": "(evt: Event) => void" } ], "optional": false, "required": false }, { "name": "icon", "type": "\"amazon\" | \"auth0\" | \"ban\" | \"enter-vr\" | \"exit-vr\" | \"facebook\" | \"google\" | \"loading\" | \"maximize\" | \"microphone\" | \"minimize\" | \"photoPlaceholder\" | \"send\" | \"sound\" | \"sound-mute\" | \"warning\"", "mutable": false, "attr": "icon", "reflectToAttr": false, "docs": "Name of icon to be placed inside the button", "docsTags": [], "values": [ { "value": "amazon", "type": "string" }, { "value": "auth0", "type": "string" }, { "value": "ban", "type": "string" }, { "value": "enter-vr", "type": "string" }, { "value": "exit-vr", "type": "string" }, { "value": "facebook", "type": "string" }, { "value": "google", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "maximize", "type": "string" }, { "value": "microphone", "type": "string" }, { "value": "minimize", "type": "string" }, { "value": "photoPlaceholder", "type": "string" }, { "value": "send", "type": "string" }, { "value": "sound", "type": "string" }, { "value": "sound-mute", "type": "string" }, { "value": "warning", "type": "string" } ], "optional": true, "required": false }, { "name": "type", "type": "\"button\" | \"reset\" | \"submit\"", "mutable": false, "attr": "type", "reflectToAttr": false, "docs": "Type of the button: 'button', 'submit' or 'reset'", "docsTags": [], "default": "'button'", "values": [ { "value": "button", "type": "string" }, { "value": "reset", "type": "string" }, { "value": "submit", "type": "string" } ], "optional": false, "required": false }, { "name": "variant", "type": "\"anchor\" | \"button\" | \"icon\"", "mutable": false, "attr": "variant", "reflectToAttr": false, "docs": "Variant of a button: 'button' | 'anchor | 'icon'", "docsTags": [], "default": "'button'", "values": [ { "value": "anchor", "type": "string" }, { "value": "button", "type": "string" }, { "value": "icon", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--background-color", "annotation": "prop", "docs": "Background color of the button" }, { "name": "--background-color-active", "annotation": "prop", "docs": "Background color of the button when it's active" }, { "name": "--background-color-disable", "annotation": "prop", "docs": "Background color of the button when it's disabled" }, { "name": "--border-color", "annotation": "prop", "docs": "Border color of the button" }, { "name": "--border-radius", "annotation": "prop", "docs": "Border radius of the button" }, { "name": "--border-style", "annotation": "prop", "docs": "Border style of the button" }, { "name": "--border-width", "annotation": "prop", "docs": "Border width of the button" }, { "name": "--color", "annotation": "prop", "docs": "Text color within the button" }, { "name": "--icon-fill", "annotation": "prop", "docs": "Icon fill color within an icon variant button" }, { "name": "--icon-height", "annotation": "prop", "docs": "Icon height within an icon variant button" }, { "name": "--link-active", "annotation": "prop", "docs": "Text color within the anchor variant button when active" }, { "name": "--link-color", "annotation": "prop", "docs": "Text color within an anchor variant button" }, { "name": "--link-hover", "annotation": "prop", "docs": "Text color within an anchor variant button when hovering" }, { "name": "--padding", "annotation": "prop", "docs": "Padding within the button" }, { "name": "--text-transform", "annotation": "prop", "docs": "Text capitalization transform within the button" }, { "name": "--width", "annotation": "prop", "docs": "Width of the button" } ], "slots": [ { "name": "(default)", "docs": "content placed within the button" } ], "parts": [], "dependents": [ "amplify-chatbot", "amplify-confirm-sign-in", "amplify-confirm-sign-up", "amplify-forgot-password", "amplify-form-section", "amplify-photo-picker", "amplify-picker", "amplify-require-new-password", "amplify-sign-in", "amplify-sign-out", "amplify-sign-up", "amplify-verify-contact" ], "dependencies": [ "amplify-icon" ], "dependencyGraph": { "amplify-button": [ "amplify-icon" ], "amplify-chatbot": [ "amplify-button" ], "amplify-confirm-sign-in": [ "amplify-button" ], "amplify-confirm-sign-up": [ "amplify-button" ], "amplify-forgot-password": [ "amplify-button" ], "amplify-form-section": [ "amplify-button" ], "amplify-photo-picker": [ "amplify-button" ], "amplify-picker": [ "amplify-button" ], "amplify-require-new-password": [ "amplify-button" ], "amplify-sign-in": [ "amplify-button" ], "amplify-sign-out": [ "amplify-button" ], "amplify-sign-up": [ "amplify-button" ], "amplify-verify-contact": [ "amplify-button" ] } }, { "filePath": "./src/components/amplify-chatbot/amplify-chatbot.tsx", "encapsulation": "shadow", "tag": "amplify-chatbot", "readme": "# amplify-chatbot\n\n\n", "docs": "", "docsTags": [ { "text": "header - Title content placed at the top", "name": "slot" } ], "usage": {}, "props": [ { "name": "botName", "type": "string", "mutable": false, "attr": "bot-name", "reflectToAttr": false, "docs": "Name of the bot", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "botTitle", "type": "string", "mutable": false, "attr": "bot-title", "reflectToAttr": false, "docs": "Text placed in the top header", "docsTags": [], "default": "Translations.CHATBOT_TITLE", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "clearOnComplete", "type": "boolean", "mutable": false, "attr": "clear-on-complete", "reflectToAttr": false, "docs": "Clear messages when conversation finishes", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "conversationModeOn", "type": "boolean", "mutable": false, "attr": "conversation-mode-on", "reflectToAttr": false, "docs": "Continue listening to users after they send the message", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "silenceThreshold", "type": "number", "mutable": false, "attr": "silence-threshold", "reflectToAttr": false, "docs": "Noise threshold between -1 and 1. Anything below is considered a silence.", "docsTags": [], "default": "0.2", "values": [ { "type": "number" } ], "optional": false, "required": false }, { "name": "silenceTime", "type": "number", "mutable": false, "attr": "silence-time", "reflectToAttr": false, "docs": "Amount of silence (in ms) to wait for", "docsTags": [], "default": "1500", "values": [ { "type": "number" } ], "optional": false, "required": false }, { "name": "textEnabled", "type": "boolean", "mutable": false, "attr": "text-enabled", "reflectToAttr": false, "docs": "Whether text chat is enabled", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "voiceEnabled", "type": "boolean", "mutable": false, "attr": "voice-enabled", "reflectToAttr": false, "docs": "Whether voice chat is enabled", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "welcomeMessage", "type": "string", "mutable": false, "attr": "welcome-message", "reflectToAttr": false, "docs": "Greeting message displayed to users", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "chatCompleted", "detail": "ChatResult", "bubbles": true, "cancelable": true, "composed": true, "docs": "Event emitted when conversation is completed", "docsTags": [] } ], "listeners": [ { "event": "formSubmit", "capture": false, "passive": false } ], "styles": [ { "name": "--bot-background-color", "annotation": "prop", "docs": "Background color of bot messages" }, { "name": "--bot-dot-color", "annotation": "prop", "docs": "Base color of bot loading message animation" }, { "name": "--bot-text-color", "annotation": "prop", "docs": "Text color of bot messages" }, { "name": "--header-color", "annotation": "prop", "docs": "Text color within the header" }, { "name": "--header-size", "annotation": "prop", "docs": "Text size within the header" }, { "name": "--height", "annotation": "prop", "docs": "Height of the container" }, { "name": "--user-background-color", "annotation": "prop", "docs": "Background color of user messages" }, { "name": "--user-dot-color", "annotation": "prop", "docs": "Base color of user loading message animation" }, { "name": "--user-text-color", "annotation": "prop", "docs": "Text color of user messages" }, { "name": "--width", "annotation": "prop", "docs": "Width of the container" } ], "slots": [ { "name": "header", "docs": "Title content placed at the top" } ], "parts": [], "dependents": [], "dependencies": [ "amplify-button", "amplify-input", "amplify-toast" ], "dependencyGraph": { "amplify-chatbot": [ "amplify-button", "amplify-input", "amplify-toast" ], "amplify-button": [ "amplify-icon" ], "amplify-toast": [ "amplify-icon" ] } }, { "filePath": "./src/components/amplify-checkbox/amplify-checkbox.tsx", "encapsulation": "shadow", "tag": "amplify-checkbox", "readme": "# amplify-checkbox\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "checked", "type": "boolean", "mutable": false, "attr": "checked", "reflectToAttr": false, "docs": "If `true`, the checkbox is selected.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "If `true`, the checkbox is disabled", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "fieldId", "type": "string", "mutable": false, "attr": "field-id", "reflectToAttr": false, "docs": "Field ID used for the 'htmlFor' in the label", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Label for the checkbox", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "Name of the checkbox", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "value", "type": "string", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "Value of the checkbox", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--font-family", "annotation": "prop", "docs": "Text font family" } ], "slots": [], "parts": [], "dependents": [], "dependencies": [ "amplify-label" ], "dependencyGraph": { "amplify-checkbox": [ "amplify-label" ] } }, { "filePath": "./src/components/amplify-code-field/amplify-code-field.tsx", "encapsulation": "none", "tag": "amplify-code-field", "readme": "# amplify-code-field\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "Will disable the input if set to true", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "fieldId", "type": "string", "mutable": false, "attr": "field-id", "reflectToAttr": false, "docs": "Based on the type of field e.g. sign in, sign up, forgot password, etc.", "docsTags": [], "default": "CODE_SUFFIX", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleInputChange", "type": "(inputEvent: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "The callback, called when the input is modified by the user.", "docsTags": [], "values": [ { "type": "(inputEvent: Event) => void" } ], "optional": true, "required": false }, { "name": "hint", "type": "FunctionalComponent<{}> | string", "mutable": false, "attr": "hint", "reflectToAttr": false, "docs": "Used as the hint in case you forgot your confirmation code, etc.", "docsTags": [], "values": [ { "type": "FunctionalComponent<{}>" }, { "type": "string" } ], "optional": false, "required": false }, { "name": "inputProps", "type": "object", "mutable": false, "reflectToAttr": false, "docs": "Attributes places on the input element: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes", "docsTags": [], "values": [ { "type": "object" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Used for the code label", "docsTags": [], "default": "Translations.CODE_LABEL", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "placeholder", "type": "string", "mutable": false, "attr": "placeholder", "reflectToAttr": false, "docs": "Used for the placeholder label", "docsTags": [], "default": "Translations.CODE_PLACEHOLDER", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "mutable": false, "attr": "required", "reflectToAttr": false, "docs": "The required flag in order to make an input required prior to submitting a form", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The value of the content inside of the input field", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-auth-fields" ], "dependencies": [ "amplify-form-field" ], "dependencyGraph": { "amplify-code-field": [ "amplify-form-field" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-auth-fields": [ "amplify-code-field" ] } }, { "filePath": "./src/components/amplify-confirm-sign-in/amplify-confirm-sign-in.tsx", "encapsulation": "shadow", "tag": "amplify-confirm-sign-in", "readme": "# amplify-sign-in\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "formFields", "type": "FormFieldTypes | string[]", "mutable": false, "reflectToAttr": false, "docs": "Form fields allows you to utilize our pre-built components such as username field, code field, password field, email field, etc.\nby passing an array of strings that you would like the order of the form to be in. If you need more customization, such as changing\ntext for a label or adjust a placeholder, you can follow the structure below in order to do just that.\n```\n[\n {\n type: string,\n label: string,\n placeholder: string,\n hint: string | Functional Component | null,\n required: boolean\n }\n]\n```", "docsTags": [], "default": "this.defaultFormFields", "values": [ { "type": "FormFieldTypes" }, { "type": "string[]" } ], "optional": false, "required": false }, { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this component", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false }, { "name": "handleSubmit", "type": "(event: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "Fires when confirm sign in form is submitted", "docsTags": [], "default": "event => this.confirm(event)", "values": [ { "type": "(event: Event) => void" } ], "optional": false, "required": false }, { "name": "headerText", "type": "string", "mutable": false, "attr": "header-text", "reflectToAttr": false, "docs": "Used for header text in confirm sign in component", "docsTags": [], "default": "Translations.CONFIRM_SMS_CODE", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "submitButtonText", "type": "string", "mutable": false, "attr": "submit-button-text", "reflectToAttr": false, "docs": "Used for the submit button text in confirm sign in component", "docsTags": [], "default": "Translations.CONFIRM", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "user", "type": "CognitoUserInterface", "mutable": false, "reflectToAttr": false, "docs": "Cognito user signing in", "docsTags": [], "values": [ { "type": "CognitoUserInterface" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-authenticator" ], "dependencies": [ "amplify-form-section", "amplify-button", "amplify-auth-fields" ], "dependencyGraph": { "amplify-confirm-sign-in": [ "amplify-form-section", "amplify-button", "amplify-auth-fields" ], "amplify-form-section": [ "amplify-section", "amplify-button", "amplify-loading-spinner" ], "amplify-button": [ "amplify-icon" ], "amplify-loading-spinner": [ "amplify-icon" ], "amplify-auth-fields": [ "amplify-username-field", "amplify-password-field", "amplify-email-field", "amplify-code-field", "amplify-phone-field", "amplify-form-field" ], "amplify-username-field": [ "amplify-form-field" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-password-field": [ "amplify-form-field" ], "amplify-email-field": [ "amplify-form-field" ], "amplify-code-field": [ "amplify-form-field" ], "amplify-phone-field": [ "amplify-form-field", "amplify-country-dial-code", "amplify-input" ], "amplify-country-dial-code": [ "amplify-select" ], "amplify-authenticator": [ "amplify-confirm-sign-in" ] } }, { "filePath": "./src/components/amplify-confirm-sign-up/amplify-confirm-sign-up.tsx", "encapsulation": "shadow", "tag": "amplify-confirm-sign-up", "readme": "# amplify-sign-up\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "formFields", "type": "FormFieldTypes | string[]", "mutable": false, "reflectToAttr": false, "docs": "Form fields allows you to utilize our pre-built components such as username field, code field, password field, email field, etc.\nby passing an array of strings that you would like the order of the form to be in. If you need more customization, such as changing\ntext for a label or adjust a placeholder, you can follow the structure below in order to do just that.\n```\n[\n {\n type: string,\n label: string,\n placeholder: string,\n hint: string | Functional Component | null,\n required: boolean\n }\n]\n```", "docsTags": [], "default": "[]", "values": [ { "type": "FormFieldTypes" }, { "type": "string[]" } ], "optional": false, "required": false }, { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this components\ne.g. SignIn -> 'Create Account' link -> SignUp", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false }, { "name": "handleSubmit", "type": "(submitEvent: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "Fires when sign up form is submitted", "docsTags": [], "default": "event =>\n\t\tthis.confirmSignUp(event)", "values": [ { "type": "(submitEvent: Event) => void" } ], "optional": false, "required": false }, { "name": "headerText", "type": "string", "mutable": false, "attr": "header-text", "reflectToAttr": false, "docs": "Used for header text in confirm sign up component", "docsTags": [], "default": "Translations.CONFIRM_SIGN_UP_HEADER_TEXT", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "submitButtonText", "type": "string", "mutable": false, "attr": "submit-button-text", "reflectToAttr": false, "docs": "Used for the submit button text in confirm sign up component", "docsTags": [], "default": "Translations.CONFIRM_SIGN_UP_SUBMIT_BUTTON_TEXT", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "user", "type": "CognitoUserInterface", "mutable": false, "reflectToAttr": false, "docs": "Used for the username to be passed to resend code", "docsTags": [], "values": [ { "type": "CognitoUserInterface" } ], "optional": false, "required": false }, { "name": "usernameAlias", "type": "\"email\" | \"phone_number\" | \"username\"", "mutable": false, "attr": "username-alias", "reflectToAttr": false, "docs": "Username Alias is used to setup authentication with `username`, `email` or `phone_number`", "docsTags": [], "default": "'username'", "values": [ { "value": "email", "type": "string" }, { "value": "phone_number", "type": "string" }, { "value": "username", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-authenticator" ], "dependencies": [ "amplify-button", "amplify-form-section", "amplify-auth-fields" ], "dependencyGraph": { "amplify-confirm-sign-up": [ "amplify-button", "amplify-form-section", "amplify-auth-fields" ], "amplify-button": [ "amplify-icon" ], "amplify-form-section": [ "amplify-section", "amplify-button", "amplify-loading-spinner" ], "amplify-loading-spinner": [ "amplify-icon" ], "amplify-auth-fields": [ "amplify-username-field", "amplify-password-field", "amplify-email-field", "amplify-code-field", "amplify-phone-field", "amplify-form-field" ], "amplify-username-field": [ "amplify-form-field" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-password-field": [ "amplify-form-field" ], "amplify-email-field": [ "amplify-form-field" ], "amplify-code-field": [ "amplify-form-field" ], "amplify-phone-field": [ "amplify-form-field", "amplify-country-dial-code", "amplify-input" ], "amplify-country-dial-code": [ "amplify-select" ], "amplify-authenticator": [ "amplify-confirm-sign-up" ] } }, { "filePath": "./src/components/amplify-container/amplify-container.tsx", "encapsulation": "none", "tag": "amplify-container", "readme": "# amplify-container\n\n\n", "docs": "", "docsTags": [ { "text": "(default) - Content placed within the container", "name": "slot" } ], "usage": {}, "props": [], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "(default)", "docs": "Content placed within the container" } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/amplify-country-dial-code/amplify-country-dial-code.tsx", "encapsulation": "shadow", "tag": "amplify-country-dial-code", "readme": "# amplify-country-dial-code\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "dialCode", "type": "number | string", "mutable": false, "attr": "dial-code", "reflectToAttr": false, "docs": "Default selected dial code", "docsTags": [], "default": "'+1'", "values": [ { "type": "number" }, { "type": "string" } ], "optional": false, "required": false }, { "name": "fieldId", "type": "string", "mutable": false, "attr": "field-id", "reflectToAttr": false, "docs": "The ID of the field. Should match with its corresponding input's ID.", "docsTags": [], "default": "COUNTRY_DIAL_CODE_SUFFIX", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleInputChange", "type": "(inputEvent: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "The callback, called when the input is modified by the user.", "docsTags": [], "values": [ { "type": "(inputEvent: Event) => void" } ], "optional": true, "required": false }, { "name": "options", "type": "CountryCodeDialOptions", "mutable": false, "reflectToAttr": false, "docs": "The options of the country dial code select input.", "docsTags": [], "default": "countryDialCodes", "values": [ { "type": "CountryCodeDialOptions" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-phone-field" ], "dependencies": [ "amplify-select" ], "dependencyGraph": { "amplify-country-dial-code": [ "amplify-select" ], "amplify-phone-field": [ "amplify-country-dial-code" ] } }, { "filePath": "./src/components/amplify-email-field/amplify-email-field.tsx", "encapsulation": "none", "tag": "amplify-email-field", "readme": "# amplify-email-field\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "Will disable the input if set to true", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "fieldId", "type": "string", "mutable": false, "attr": "field-id", "reflectToAttr": false, "docs": "Based on the type of field e.g. sign in, sign up, forgot password, etc.", "docsTags": [], "default": "EMAIL_SUFFIX", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleInputChange", "type": "(inputEvent: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "The callback, called when the input is modified by the user.", "docsTags": [], "values": [ { "type": "(inputEvent: Event) => void" } ], "optional": true, "required": false }, { "name": "hint", "type": "FunctionalComponent<{}> | string", "mutable": false, "attr": "hint", "reflectToAttr": false, "docs": "Used for the hint text that displays underneath the input field", "docsTags": [], "values": [ { "type": "FunctionalComponent<{}>" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "inputProps", "type": "object", "mutable": false, "reflectToAttr": false, "docs": "Attributes places on the input element: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes", "docsTags": [], "values": [ { "type": "object" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Used for the EMAIL label", "docsTags": [], "default": "Translations.EMAIL_LABEL", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "placeholder", "type": "string", "mutable": false, "attr": "placeholder", "reflectToAttr": false, "docs": "Used for the placeholder label", "docsTags": [], "default": "Translations.EMAIL_PLACEHOLDER", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "mutable": false, "attr": "required", "reflectToAttr": false, "docs": "The required flag in order to make an input required prior to submitting a form", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The value of the content inside of the input field", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-auth-fields" ], "dependencies": [ "amplify-form-field" ], "dependencyGraph": { "amplify-email-field": [ "amplify-form-field" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-auth-fields": [ "amplify-email-field" ] } }, { "filePath": "./src/components/amplify-facebook-button/amplify-facebook-button.tsx", "encapsulation": "shadow", "tag": "amplify-facebook-button", "readme": "# amplify-facebook-button\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "appId", "type": "string", "mutable": false, "attr": "app-id", "reflectToAttr": false, "docs": "App-specific client ID from Facebook", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this component\ne.g. SignIn -> 'Create Account' link -> SignUp", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-federated-buttons" ], "dependencies": [ "amplify-sign-in-button" ], "dependencyGraph": { "amplify-facebook-button": [ "amplify-sign-in-button" ], "amplify-sign-in-button": [ "amplify-icon" ], "amplify-federated-buttons": [ "amplify-facebook-button" ] } }, { "filePath": "./src/components/amplify-federated-buttons/amplify-federated-buttons.tsx", "encapsulation": "shadow", "tag": "amplify-federated-buttons", "readme": "# amplify-federated-buttons\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "authState", "type": "AuthState.ConfirmSignIn | AuthState.ConfirmSignUp | AuthState.CustomConfirmSignIn | AuthState.ForgotPassword | AuthState.Loading | AuthState.ResetPassword | AuthState.SettingMFA | AuthState.SignIn | AuthState.SignOut | AuthState.SignUp | AuthState.SignedIn | AuthState.SignedOut | AuthState.SigningUp | AuthState.TOTPSetup | AuthState.VerifyContact | AuthState.VerifyingAttributes | AuthState.confirmingSignInCustomFlow | AuthState.confirmingSignUpCustomFlow", "mutable": false, "attr": "auth-state", "reflectToAttr": false, "docs": "The current authentication state.", "docsTags": [], "default": "AuthState.SignIn", "values": [ { "type": "AuthState.ConfirmSignIn" }, { "type": "AuthState.ConfirmSignUp" }, { "type": "AuthState.CustomConfirmSignIn" }, { "type": "AuthState.ForgotPassword" }, { "type": "AuthState.Loading" }, { "type": "AuthState.ResetPassword" }, { "type": "AuthState.SettingMFA" }, { "type": "AuthState.SignIn" }, { "type": "AuthState.SignOut" }, { "type": "AuthState.SignUp" }, { "type": "AuthState.SignedIn" }, { "type": "AuthState.SignedOut" }, { "type": "AuthState.SigningUp" }, { "type": "AuthState.TOTPSetup" }, { "type": "AuthState.VerifyContact" }, { "type": "AuthState.VerifyingAttributes" }, { "type": "AuthState.confirmingSignInCustomFlow" }, { "type": "AuthState.confirmingSignUpCustomFlow" } ], "optional": false, "required": false }, { "name": "federated", "type": "FederatedConfig", "mutable": false, "reflectToAttr": false, "docs": "Federated credentials & configuration.", "docsTags": [], "default": "{}", "values": [ { "type": "FederatedConfig" } ], "optional": false, "required": false }, { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this component\ne.g. SignIn -> 'Create Account' link -> SignUp", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-federated-sign-in", "amplify-sign-in" ], "dependencies": [ "amplify-google-button", "amplify-facebook-button", "amplify-amazon-button", "amplify-oauth-button", "amplify-auth0-button" ], "dependencyGraph": { "amplify-federated-buttons": [ "amplify-google-button", "amplify-facebook-button", "amplify-amazon-button", "amplify-oauth-button", "amplify-auth0-button" ], "amplify-google-button": [ "amplify-sign-in-button" ], "amplify-sign-in-button": [ "amplify-icon" ], "amplify-facebook-button": [ "amplify-sign-in-button" ], "amplify-amazon-button": [ "amplify-sign-in-button" ], "amplify-oauth-button": [ "amplify-sign-in-button" ], "amplify-auth0-button": [ "amplify-sign-in-button" ], "amplify-federated-sign-in": [ "amplify-federated-buttons" ], "amplify-sign-in": [ "amplify-federated-buttons" ] } }, { "filePath": "./src/components/amplify-federated-sign-in/amplify-federated-sign-in.tsx", "encapsulation": "shadow", "tag": "amplify-federated-sign-in", "readme": "# amplify-federated-sign-in\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "authState", "type": "AuthState.ConfirmSignIn | AuthState.ConfirmSignUp | AuthState.CustomConfirmSignIn | AuthState.ForgotPassword | AuthState.Loading | AuthState.ResetPassword | AuthState.SettingMFA | AuthState.SignIn | AuthState.SignOut | AuthState.SignUp | AuthState.SignedIn | AuthState.SignedOut | AuthState.SigningUp | AuthState.TOTPSetup | AuthState.VerifyContact | AuthState.VerifyingAttributes | AuthState.confirmingSignInCustomFlow | AuthState.confirmingSignUpCustomFlow", "mutable": false, "attr": "auth-state", "reflectToAttr": false, "docs": "The current authentication state.", "docsTags": [], "default": "AuthState.SignIn", "values": [ { "type": "AuthState.ConfirmSignIn" }, { "type": "AuthState.ConfirmSignUp" }, { "type": "AuthState.CustomConfirmSignIn" }, { "type": "AuthState.ForgotPassword" }, { "type": "AuthState.Loading" }, { "type": "AuthState.ResetPassword" }, { "type": "AuthState.SettingMFA" }, { "type": "AuthState.SignIn" }, { "type": "AuthState.SignOut" }, { "type": "AuthState.SignUp" }, { "type": "AuthState.SignedIn" }, { "type": "AuthState.SignedOut" }, { "type": "AuthState.SigningUp" }, { "type": "AuthState.TOTPSetup" }, { "type": "AuthState.VerifyContact" }, { "type": "AuthState.VerifyingAttributes" }, { "type": "AuthState.confirmingSignInCustomFlow" }, { "type": "AuthState.confirmingSignUpCustomFlow" } ], "optional": false, "required": false }, { "name": "federated", "type": "any", "mutable": false, "attr": "federated", "reflectToAttr": false, "docs": "Federated credentials & configuration.", "docsTags": [], "default": "{}", "values": [ { "type": "any" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "amplify-form-section", "amplify-section", "amplify-federated-buttons" ], "dependencyGraph": { "amplify-federated-sign-in": [ "amplify-form-section", "amplify-section", "amplify-federated-buttons" ], "amplify-form-section": [ "amplify-section", "amplify-button", "amplify-loading-spinner" ], "amplify-button": [ "amplify-icon" ], "amplify-loading-spinner": [ "amplify-icon" ], "amplify-federated-buttons": [ "amplify-google-button", "amplify-facebook-button", "amplify-amazon-button", "amplify-oauth-button", "amplify-auth0-button" ], "amplify-google-button": [ "amplify-sign-in-button" ], "amplify-sign-in-button": [ "amplify-icon" ], "amplify-facebook-button": [ "amplify-sign-in-button" ], "amplify-amazon-button": [ "amplify-sign-in-button" ], "amplify-oauth-button": [ "amplify-sign-in-button" ], "amplify-auth0-button": [ "amplify-sign-in-button" ] } }, { "filePath": "./src/components/amplify-forgot-password/amplify-forgot-password.tsx", "encapsulation": "shadow", "tag": "amplify-forgot-password", "readme": "# amplify-forgot-password\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "formFields", "type": "FormFieldTypes | string[]", "mutable": false, "reflectToAttr": false, "docs": "The form fields displayed inside of the forgot password form", "docsTags": [], "default": "[]", "values": [ { "type": "FormFieldTypes" }, { "type": "string[]" } ], "optional": false, "required": false }, { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this component", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false }, { "name": "handleSend", "type": "(event: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "The function called when making a request to reset password", "docsTags": [], "default": "event => this.send(event)", "values": [ { "type": "(event: Event) => void" } ], "optional": false, "required": false }, { "name": "handleSubmit", "type": "(event: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "The function called when submitting a new password", "docsTags": [], "default": "event => this.submit(event)", "values": [ { "type": "(event: Event) => void" } ], "optional": false, "required": false }, { "name": "headerText", "type": "string", "mutable": false, "attr": "header-text", "reflectToAttr": false, "docs": "The header text of the forgot password section", "docsTags": [], "default": "Translations.RESET_YOUR_PASSWORD", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "sendButtonText", "type": "string", "mutable": false, "attr": "send-button-text", "reflectToAttr": false, "docs": "The text displayed inside of the send code button for the form", "docsTags": [], "default": "Translations.SEND_CODE", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "submitButtonText", "type": "string", "mutable": false, "attr": "submit-button-text", "reflectToAttr": false, "docs": "The text displayed inside of the submit button for the form", "docsTags": [], "default": "Translations.SUBMIT", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "usernameAlias", "type": "\"email\" | \"phone_number\" | \"username\"", "mutable": false, "attr": "username-alias", "reflectToAttr": false, "docs": "Username Alias is used to setup authentication with `username`, `email` or `phone_number`", "docsTags": [], "default": "'username'", "values": [ { "value": "email", "type": "string" }, { "value": "phone_number", "type": "string" }, { "value": "username", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-authenticator" ], "dependencies": [ "amplify-form-section", "amplify-button", "amplify-auth-fields" ], "dependencyGraph": { "amplify-forgot-password": [ "amplify-form-section", "amplify-button", "amplify-auth-fields" ], "amplify-form-section": [ "amplify-section", "amplify-button", "amplify-loading-spinner" ], "amplify-button": [ "amplify-icon" ], "amplify-loading-spinner": [ "amplify-icon" ], "amplify-auth-fields": [ "amplify-username-field", "amplify-password-field", "amplify-email-field", "amplify-code-field", "amplify-phone-field", "amplify-form-field" ], "amplify-username-field": [ "amplify-form-field" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-password-field": [ "amplify-form-field" ], "amplify-email-field": [ "amplify-form-field" ], "amplify-code-field": [ "amplify-form-field" ], "amplify-phone-field": [ "amplify-form-field", "amplify-country-dial-code", "amplify-input" ], "amplify-country-dial-code": [ "amplify-select" ], "amplify-authenticator": [ "amplify-forgot-password" ] } }, { "filePath": "./src/components/amplify-form-field/amplify-form-field.tsx", "encapsulation": "none", "tag": "amplify-form-field", "readme": "# amplify-form-field\n", "docs": "", "docsTags": [ { "text": "input - Content for the input within the form field", "name": "slot" } ], "usage": {}, "props": [ { "name": "description", "type": "string", "mutable": false, "attr": "description", "reflectToAttr": false, "docs": "The text of the description. Goes between the label and the input.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "Will disable the input if set to true", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "fieldId", "type": "string", "mutable": false, "attr": "field-id", "reflectToAttr": false, "docs": "The ID of the field. Should match with its corresponding input's ID.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleInputChange", "type": "(inputEvent: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "The callback, called when the input is modified by the user.", "docsTags": [], "values": [ { "type": "(inputEvent: Event) => void" } ], "optional": true, "required": false }, { "name": "hint", "type": "FunctionalComponent<{}> | string", "mutable": false, "attr": "hint", "reflectToAttr": false, "docs": "The text of a hint to the user as to how to fill out the input. Goes just below the input.", "docsTags": [], "values": [ { "type": "FunctionalComponent<{}>" }, { "type": "string" } ], "optional": false, "required": false }, { "name": "inputProps", "type": "object", "mutable": false, "reflectToAttr": false, "docs": "Attributes places on the input element: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes", "docsTags": [], "values": [ { "type": "object" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "The text of the label. Goes above the input. Ex: 'First name'", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "(Optional) String value for the name of the input.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "placeholder", "type": "string", "mutable": false, "attr": "placeholder", "reflectToAttr": false, "docs": "(Optional) The placeholder for the input element. Using hints is recommended, but placeholders can also be useful to convey information to users.", "docsTags": [], "default": "''", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "required", "type": "boolean", "mutable": false, "attr": "required", "reflectToAttr": false, "docs": "The required flag in order to make an input required prior to submitting a form", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "type", "type": "\"date\" | \"email\" | \"number\" | \"password\" | \"search\" | \"tel\" | \"text\" | \"time\" | \"url\"", "mutable": false, "attr": "type", "reflectToAttr": false, "docs": "The input type. Can be any HTML input type.", "docsTags": [], "default": "'text'", "values": [ { "value": "date", "type": "string" }, { "value": "email", "type": "string" }, { "value": "number", "type": "string" }, { "value": "password", "type": "string" }, { "value": "search", "type": "string" }, { "value": "tel", "type": "string" }, { "value": "text", "type": "string" }, { "value": "time", "type": "string" }, { "value": "url", "type": "string" } ], "optional": true, "required": false }, { "name": "value", "type": "string", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The value of the content inside of the input field", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "input", "docs": "Content for the input within the form field" } ], "parts": [], "dependents": [ "amplify-auth-fields", "amplify-code-field", "amplify-email-field", "amplify-password-field", "amplify-phone-field", "amplify-totp-setup", "amplify-username-field" ], "dependencies": [ "amplify-label", "amplify-input", "amplify-hint" ], "dependencyGraph": { "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-auth-fields": [ "amplify-form-field" ], "amplify-code-field": [ "amplify-form-field" ], "amplify-email-field": [ "amplify-form-field" ], "amplify-password-field": [ "amplify-form-field" ], "amplify-phone-field": [ "amplify-form-field" ], "amplify-totp-setup": [ "amplify-form-field" ], "amplify-username-field": [ "amplify-form-field" ] } }, { "filePath": "./src/components/amplify-form-section/amplify-form-section.tsx", "encapsulation": "none", "tag": "amplify-form-section", "readme": "# amplify-form-section\n", "docs": "", "docsTags": [ { "text": "amplify-form-section-header - Content for the header section", "name": "slot" }, { "text": "subtitle - Content for the subtitle. This is inside of `amplify-form-section-header`.", "name": "slot" }, { "text": "amplify-form-section-footer - Content for the footer section.", "name": "slot" } ], "usage": {}, "props": [ { "name": "handleSubmit", "type": "(event: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "(Required) Function called upon submission of form", "docsTags": [], "values": [ { "type": "(event: Event) => void" } ], "optional": false, "required": false }, { "name": "headerText", "type": "string", "mutable": false, "attr": "header-text", "reflectToAttr": false, "docs": "Used for form section header", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "loading", "type": "boolean", "mutable": false, "attr": "loading", "reflectToAttr": false, "docs": "Loading state for the form", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "secondaryFooterContent", "type": "FunctionalComponent<{}> | string", "mutable": false, "attr": "secondary-footer-content", "reflectToAttr": false, "docs": "Secondary footer component or text", "docsTags": [], "default": "null", "values": [ { "type": "FunctionalComponent<{}>" }, { "type": "string" } ], "optional": false, "required": false }, { "name": "submitButtonText", "type": "string", "mutable": false, "attr": "submit-button-text", "reflectToAttr": false, "docs": "(Optional) Used as a the default value within the default footer slot", "docsTags": [], "default": "'Submit'", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "testDataPrefix", "type": "string", "mutable": false, "attr": "test-data-prefix", "reflectToAttr": false, "docs": "String prefix for the data-test attributes in this component primarily used for testing purposes", "docsTags": [], "default": "'form-section'", "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [ { "event": "formSubmit", "capture": false, "passive": false } ], "styles": [ { "name": "--font-family", "annotation": "prop", "docs": "Text font family within the footer" }, { "name": "--font-weight", "annotation": "prop", "docs": "Text weight within the footer" }, { "name": "--footer-color", "annotation": "prop", "docs": "Text color within the footer" }, { "name": "--footer-size", "annotation": "prop", "docs": "Text size within the footer" }, { "name": "--header-color", "annotation": "prop", "docs": "Text color within the form header" }, { "name": "--header-size", "annotation": "prop", "docs": "Text size within the form header" }, { "name": "--subtitle-color", "annotation": "prop", "docs": "Text color within the subtitle" }, { "name": "--subtitle-size", "annotation": "prop", "docs": "Text size within the subtitle" } ], "slots": [ { "name": "amplify-form-section-footer", "docs": "Content for the footer section." }, { "name": "amplify-form-section-header", "docs": "Content for the header section" }, { "name": "subtitle", "docs": "Content for the subtitle. This is inside of `amplify-form-section-header`." } ], "parts": [], "dependents": [ "amplify-confirm-sign-in", "amplify-confirm-sign-up", "amplify-federated-sign-in", "amplify-forgot-password", "amplify-require-new-password", "amplify-select-mfa-type", "amplify-sign-in", "amplify-sign-up", "amplify-totp-setup", "amplify-verify-contact" ], "dependencies": [ "amplify-section", "amplify-button", "amplify-loading-spinner" ], "dependencyGraph": { "amplify-form-section": [ "amplify-section", "amplify-button", "amplify-loading-spinner" ], "amplify-button": [ "amplify-icon" ], "amplify-loading-spinner": [ "amplify-icon" ], "amplify-confirm-sign-in": [ "amplify-form-section" ], "amplify-confirm-sign-up": [ "amplify-form-section" ], "amplify-federated-sign-in": [ "amplify-form-section" ], "amplify-forgot-password": [ "amplify-form-section" ], "amplify-require-new-password": [ "amplify-form-section" ], "amplify-select-mfa-type": [ "amplify-form-section" ], "amplify-sign-in": [ "amplify-form-section" ], "amplify-sign-up": [ "amplify-form-section" ], "amplify-totp-setup": [ "amplify-form-section" ], "amplify-verify-contact": [ "amplify-form-section" ] } }, { "filePath": "./src/components/amplify-google-button/amplify-google-button.tsx", "encapsulation": "shadow", "tag": "amplify-google-button", "readme": "# amplify-google-button\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "clientId", "type": "string", "mutable": false, "attr": "client-id", "reflectToAttr": false, "docs": "App-specific client ID from Google", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this component\ne.g. SignIn -> 'Create Account' link -> SignUp", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-federated-buttons" ], "dependencies": [ "amplify-sign-in-button" ], "dependencyGraph": { "amplify-google-button": [ "amplify-sign-in-button" ], "amplify-sign-in-button": [ "amplify-icon" ], "amplify-federated-buttons": [ "amplify-google-button" ] } }, { "filePath": "./src/components/amplify-greetings/amplify-greetings.tsx", "encapsulation": "shadow", "tag": "amplify-greetings", "readme": "# amplify-greetings\n\n\n", "docs": "", "docsTags": [ { "text": "logo - Left-justified content placed at the start of the greetings bar", "name": "slot" }, { "text": "nav - Right-justified content placed at the end of the greetings bar", "name": "slot" }, { "text": "greetings-message - Content placed in the greetings text", "name": "slot" } ], "usage": {}, "props": [ { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this component", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false }, { "name": "logo", "type": "FunctionalComponent<{}>", "mutable": false, "reflectToAttr": false, "docs": "Logo displayed inside of the header", "docsTags": [], "default": "null", "values": [ { "type": "FunctionalComponent<{}>" } ], "optional": false, "required": false }, { "name": "username", "type": "string", "mutable": false, "attr": "username", "reflectToAttr": false, "docs": "Username displayed in the greetings", "docsTags": [], "default": "null", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--background-color", "annotation": "prop", "docs": "Background color of the container" }, { "name": "--border-color", "annotation": "prop", "docs": "Border color of the container" }, { "name": "--font-family", "annotation": "prop", "docs": "Font family of the text" } ], "slots": [ { "name": "greetings-message", "docs": "Content placed in the greetings text" }, { "name": "logo", "docs": "Left-justified content placed at the start of the greetings bar" }, { "name": "nav", "docs": "Right-justified content placed at the end of the greetings bar" } ], "parts": [], "dependents": [], "dependencies": [ "amplify-nav", "amplify-sign-out" ], "dependencyGraph": { "amplify-greetings": [ "amplify-nav", "amplify-sign-out" ], "amplify-sign-out": [ "amplify-button" ], "amplify-button": [ "amplify-icon" ] } }, { "filePath": "./src/components/amplify-hint/amplify-hint.tsx", "encapsulation": "shadow", "tag": "amplify-hint", "readme": "# amplify-hint\n\n\n", "docs": "", "docsTags": [ { "text": "(default) - Content for the hint", "name": "slot" } ], "usage": {}, "props": [], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--color", "annotation": "prop", "docs": "Color of the text" }, { "name": "--font-family", "annotation": "prop", "docs": "Font family of the text" }, { "name": "--font-size", "annotation": "prop", "docs": "Font size of the text" }, { "name": "--font-weight", "annotation": "prop", "docs": "Font weight of the text" } ], "slots": [ { "name": "(default)", "docs": "Content for the hint" } ], "parts": [], "dependents": [ "amplify-form-field" ], "dependencies": [], "dependencyGraph": { "amplify-form-field": [ "amplify-hint" ] } }, { "filePath": "./src/components/amplify-icon/amplify-icon.tsx", "encapsulation": "scoped", "tag": "amplify-icon", "readme": "# amplify-icon\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "name", "type": "\"amazon\" | \"auth0\" | \"ban\" | \"enter-vr\" | \"exit-vr\" | \"facebook\" | \"google\" | \"loading\" | \"maximize\" | \"microphone\" | \"minimize\" | \"photoPlaceholder\" | \"send\" | \"sound\" | \"sound-mute\" | \"warning\"", "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "(Required) Name of icon used to determine the icon rendered", "docsTags": [], "values": [ { "value": "amazon", "type": "string" }, { "value": "auth0", "type": "string" }, { "value": "ban", "type": "string" }, { "value": "enter-vr", "type": "string" }, { "value": "exit-vr", "type": "string" }, { "value": "facebook", "type": "string" }, { "value": "google", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "maximize", "type": "string" }, { "value": "microphone", "type": "string" }, { "value": "minimize", "type": "string" }, { "value": "photoPlaceholder", "type": "string" }, { "value": "send", "type": "string" }, { "value": "sound", "type": "string" }, { "value": "sound-mute", "type": "string" }, { "value": "warning", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--height", "annotation": "prop", "docs": "Height of the icon" }, { "name": "--icon-fill-color", "annotation": "prop", "docs": "Fill color of the icon" }, { "name": "--width", "annotation": "prop", "docs": "Width of the icon" } ], "slots": [], "parts": [], "dependents": [ "amplify-button", "amplify-icon-button", "amplify-loading-spinner", "amplify-photo-picker", "amplify-sign-in-button", "amplify-toast" ], "dependencies": [], "dependencyGraph": { "amplify-button": [ "amplify-icon" ], "amplify-icon-button": [ "amplify-icon" ], "amplify-loading-spinner": [ "amplify-icon" ], "amplify-photo-picker": [ "amplify-icon" ], "amplify-sign-in-button": [ "amplify-icon" ], "amplify-toast": [ "amplify-icon" ] } }, { "filePath": "./src/components/amplify-icon-button/amplify-icon-button.tsx", "encapsulation": "shadow", "tag": "amplify-icon-button", "readme": "# amplify-icon-button\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "autoShowTooltip", "type": "boolean", "mutable": false, "attr": "auto-show-tooltip", "reflectToAttr": false, "docs": "(Optional) Whether or not to show the tooltip automatically", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "name", "type": "\"amazon\" | \"auth0\" | \"ban\" | \"enter-vr\" | \"exit-vr\" | \"facebook\" | \"google\" | \"loading\" | \"maximize\" | \"microphone\" | \"minimize\" | \"photoPlaceholder\" | \"send\" | \"sound\" | \"sound-mute\" | \"warning\"", "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "The name of the icon used inside of the button", "docsTags": [], "values": [ { "value": "amazon", "type": "string" }, { "value": "auth0", "type": "string" }, { "value": "ban", "type": "string" }, { "value": "enter-vr", "type": "string" }, { "value": "exit-vr", "type": "string" }, { "value": "facebook", "type": "string" }, { "value": "google", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "maximize", "type": "string" }, { "value": "microphone", "type": "string" }, { "value": "minimize", "type": "string" }, { "value": "photoPlaceholder", "type": "string" }, { "value": "send", "type": "string" }, { "value": "sound", "type": "string" }, { "value": "sound-mute", "type": "string" }, { "value": "warning", "type": "string" } ], "optional": false, "required": false }, { "name": "tooltip", "type": "string", "mutable": false, "attr": "tooltip", "reflectToAttr": false, "docs": "(Optional) The tooltip that will show on hover of the button", "docsTags": [], "default": "null", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--button-background-hover", "annotation": "prop", "docs": "Background color of the button when it's hovered" }, { "name": "--button-color", "annotation": "prop", "docs": "Text color of the button" } ], "slots": [], "parts": [], "dependents": [], "dependencies": [ "amplify-tooltip", "amplify-icon" ], "dependencyGraph": { "amplify-icon-button": [ "amplify-tooltip", "amplify-icon" ] } }, { "filePath": "./src/components/amplify-input/amplify-input.tsx", "encapsulation": "none", "tag": "amplify-input", "readme": "# amplify-input\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "description", "type": "string", "mutable": false, "attr": "description", "reflectToAttr": false, "docs": "The text of the description. Goes just below the label.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "Will disable the input if set to true", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "fieldId", "type": "string", "mutable": false, "attr": "field-id", "reflectToAttr": false, "docs": "The ID of the field. Should match with its corresponding input's ID.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleInputChange", "type": "(inputEvent: InputEvent) => void", "mutable": false, "reflectToAttr": false, "docs": "The callback, called when the input is modified by the user.", "docsTags": [], "default": "() => void 0", "values": [ { "type": "(inputEvent: InputEvent) => void" } ], "optional": true, "required": false }, { "name": "inputProps", "type": "object", "mutable": false, "reflectToAttr": false, "docs": "Attributes places on the input element: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes", "docsTags": [], "values": [ { "type": "object" } ], "optional": true, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "(Optional) String value for the name of the input.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "placeholder", "type": "string", "mutable": false, "attr": "placeholder", "reflectToAttr": false, "docs": "(Optional) The placeholder for the input element. Using hints is recommended, but placeholders can also be useful to convey information to users.", "docsTags": [], "default": "''", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "required", "type": "boolean", "mutable": false, "attr": "required", "reflectToAttr": false, "docs": "Whether the input is a required field", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "type", "type": "\"date\" | \"email\" | \"number\" | \"password\" | \"search\" | \"tel\" | \"text\" | \"time\" | \"url\"", "mutable": false, "attr": "type", "reflectToAttr": false, "docs": "The input type. Can be any HTML input type.", "docsTags": [], "default": "'text'", "values": [ { "value": "date", "type": "string" }, { "value": "email", "type": "string" }, { "value": "number", "type": "string" }, { "value": "password", "type": "string" }, { "value": "search", "type": "string" }, { "value": "tel", "type": "string" }, { "value": "text", "type": "string" }, { "value": "time", "type": "string" }, { "value": "url", "type": "string" } ], "optional": true, "required": false }, { "name": "value", "type": "string", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The value of the content inside of the input field", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--background-color", "annotation": "prop", "docs": "Background color of the input" }, { "name": "--border-color", "annotation": "prop", "docs": "Border color of the input" }, { "name": "--border-color-focus", "annotation": "prop", "docs": "Border color of the input when focused on" }, { "name": "--color", "annotation": "prop", "docs": "Text color within the input" }, { "name": "--margin", "annotation": "prop", "docs": "Margin around the input" } ], "slots": [], "parts": [], "dependents": [ "amplify-chatbot", "amplify-form-field", "amplify-phone-field", "amplify-verify-contact" ], "dependencies": [], "dependencyGraph": { "amplify-chatbot": [ "amplify-input" ], "amplify-form-field": [ "amplify-input" ], "amplify-phone-field": [ "amplify-input" ], "amplify-verify-contact": [ "amplify-input" ] } }, { "filePath": "./src/components/amplify-label/amplify-label.tsx", "encapsulation": "none", "tag": "amplify-label", "readme": "# amplify-label\n", "docs": "", "docsTags": [ { "text": "(default) - Label content", "name": "slot" } ], "usage": {}, "props": [ { "name": "htmlFor", "type": "string", "mutable": false, "attr": "html-for", "reflectToAttr": false, "docs": "Reflects the value of the for content property of html element", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--label-color", "annotation": "prop", "docs": "Text color within the label" } ], "slots": [ { "name": "(default)", "docs": "Label content" } ], "parts": [], "dependents": [ "amplify-checkbox", "amplify-form-field", "amplify-radio-button" ], "dependencies": [], "dependencyGraph": { "amplify-checkbox": [ "amplify-label" ], "amplify-form-field": [ "amplify-label" ], "amplify-radio-button": [ "amplify-label" ] } }, { "filePath": "./src/components/amplify-link/amplify-link.tsx", "encapsulation": "shadow", "tag": "amplify-link", "readme": "# amplify-link\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "role", "type": "string", "mutable": false, "attr": "role", "reflectToAttr": false, "docs": "The link role is used to identify an element that creates a hyperlink to a resource that is in the application or external", "docsTags": [], "default": "'navigation'", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/amplify-loading-spinner/amplify-loading-spinner.tsx", "encapsulation": "shadow", "tag": "amplify-loading-spinner", "readme": "# amplify-loading-spinner\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-form-section", "amplify-sign-in", "amplify-sign-up" ], "dependencies": [ "amplify-icon" ], "dependencyGraph": { "amplify-loading-spinner": [ "amplify-icon" ], "amplify-form-section": [ "amplify-loading-spinner" ], "amplify-sign-in": [ "amplify-loading-spinner" ], "amplify-sign-up": [ "amplify-loading-spinner" ] } }, { "filePath": "./src/components/amplify-nav/amplify-nav.tsx", "encapsulation": "shadow", "tag": "amplify-nav", "readme": "# amplify-nav\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-greetings" ], "dependencies": [], "dependencyGraph": { "amplify-greetings": [ "amplify-nav" ] } }, { "filePath": "./src/components/amplify-oauth-button/amplify-oauth-button.tsx", "encapsulation": "shadow", "tag": "amplify-oauth-button", "readme": "# amplify-oauth-button\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "config", "type": "{ [key: string]: any; }", "mutable": false, "reflectToAttr": false, "docs": "Federated credentials & configuration.", "docsTags": [], "default": "{}", "values": [ { "type": "{ [key: string]: any; }" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-federated-buttons" ], "dependencies": [ "amplify-sign-in-button" ], "dependencyGraph": { "amplify-oauth-button": [ "amplify-sign-in-button" ], "amplify-sign-in-button": [ "amplify-icon" ], "amplify-federated-buttons": [ "amplify-oauth-button" ] } }, { "filePath": "./src/components/amplify-password-field/amplify-password-field.tsx", "encapsulation": "none", "tag": "amplify-password-field", "readme": "# amplify-password-field\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "Will disable the input if set to true", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "fieldId", "type": "string", "mutable": false, "attr": "field-id", "reflectToAttr": false, "docs": "Based on the type of field e.g. sign in, sign up, forgot password, etc.", "docsTags": [], "default": "PASSWORD_SUFFIX", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleInputChange", "type": "(inputEvent: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "The callback, called when the input is modified by the user.", "docsTags": [], "values": [ { "type": "(inputEvent: Event) => void" } ], "optional": true, "required": false }, { "name": "hint", "type": "FunctionalComponent<{}> | string", "mutable": false, "attr": "hint", "reflectToAttr": false, "docs": "Used as the hint in case you forgot your password, etc.", "docsTags": [], "values": [ { "type": "FunctionalComponent<{}>" }, { "type": "string" } ], "optional": false, "required": false }, { "name": "inputProps", "type": "object", "mutable": false, "reflectToAttr": false, "docs": "Attributes places on the input element: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes", "docsTags": [], "values": [ { "type": "object" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Used for the password label", "docsTags": [], "default": "Translations.PASSWORD_LABEL", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "placeholder", "type": "string", "mutable": false, "attr": "placeholder", "reflectToAttr": false, "docs": "Used for the placeholder label", "docsTags": [], "default": "Translations.PASSWORD_PLACEHOLDER", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "mutable": false, "attr": "required", "reflectToAttr": false, "docs": "The required flag in order to make an input required prior to submitting a form", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The value of the content inside of the input field", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-auth-fields" ], "dependencies": [ "amplify-form-field" ], "dependencyGraph": { "amplify-password-field": [ "amplify-form-field" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-auth-fields": [ "amplify-password-field" ] } }, { "filePath": "./src/components/amplify-phone-field/amplify-phone-field.tsx", "encapsulation": "none", "tag": "amplify-phone-field", "readme": "# amplify-code-field\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "dialCode", "type": "number | string", "mutable": false, "attr": "dial-code", "reflectToAttr": false, "docs": "Default dial code in the phone field", "docsTags": [], "values": [ { "type": "number" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "Will disable the input if set to true", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "fieldId", "type": "string", "mutable": false, "attr": "field-id", "reflectToAttr": false, "docs": "Based on the type of field e.g. sign in, sign up, forgot password, etc.", "docsTags": [], "default": "PHONE_SUFFIX", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleInputChange", "type": "(inputEvent: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "The callback, called when the input is modified by the user.", "docsTags": [], "values": [ { "type": "(inputEvent: Event) => void" } ], "optional": true, "required": false }, { "name": "hint", "type": "FunctionalComponent<{}> | string", "mutable": false, "attr": "hint", "reflectToAttr": false, "docs": "Used as the hint in case you forgot your confirmation code, etc.", "docsTags": [], "values": [ { "type": "FunctionalComponent<{}>" }, { "type": "string" } ], "optional": false, "required": false }, { "name": "inputProps", "type": "object", "mutable": false, "reflectToAttr": false, "docs": "Attributes places on the input element: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes", "docsTags": [], "values": [ { "type": "object" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Used for the Phone label", "docsTags": [], "default": "Translations.PHONE_LABEL", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "placeholder", "type": "string", "mutable": false, "attr": "placeholder", "reflectToAttr": false, "docs": "Used for the placeholder label", "docsTags": [], "default": "Translations.PHONE_PLACEHOLDER", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "mutable": false, "attr": "required", "reflectToAttr": false, "docs": "The required flag in order to make an input required prior to submitting a form", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The value of the content inside of the input field", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-auth-fields" ], "dependencies": [ "amplify-form-field", "amplify-country-dial-code", "amplify-input" ], "dependencyGraph": { "amplify-phone-field": [ "amplify-form-field", "amplify-country-dial-code", "amplify-input" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-country-dial-code": [ "amplify-select" ], "amplify-auth-fields": [ "amplify-phone-field" ] } }, { "filePath": "./src/components/amplify-photo-picker/amplify-photo-picker.tsx", "encapsulation": "shadow", "tag": "amplify-photo-picker", "readme": "# amplify-photo-picker\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "buttonText", "type": "string", "mutable": false, "attr": "button-text", "reflectToAttr": false, "docs": "Picker button text as string", "docsTags": [], "default": "Translations.PHOTO_PICKER_BUTTON_TEXT", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "handleClick", "type": "(file: File) => void", "mutable": false, "reflectToAttr": false, "docs": "Function that handles file pick onClick", "docsTags": [], "default": "() => {}", "values": [ { "type": "(file: File) => void" } ], "optional": true, "required": false }, { "name": "headerHint", "type": "string", "mutable": false, "attr": "header-hint", "reflectToAttr": false, "docs": "Header Hint value in string", "docsTags": [], "default": "Translations.PHOTO_PICKER_HINT", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "headerTitle", "type": "string", "mutable": false, "attr": "header-title", "reflectToAttr": false, "docs": "Title string value", "docsTags": [], "default": "Translations.PHOTO_PICKER_TITLE", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "placeholderHint", "type": "string", "mutable": false, "attr": "placeholder-hint", "reflectToAttr": false, "docs": "Placeholder hint that goes under the placeholder image", "docsTags": [], "default": "Translations.PHOTO_PICKER_PLACEHOLDER_HINT", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "previewSrc", "type": "object | string", "mutable": false, "attr": "preview-src", "reflectToAttr": false, "docs": "Source of the image to be previewed", "docsTags": [], "values": [ { "type": "object" }, { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-s3-image-picker" ], "dependencies": [ "amplify-section", "amplify-picker", "amplify-icon", "amplify-button" ], "dependencyGraph": { "amplify-photo-picker": [ "amplify-section", "amplify-picker", "amplify-icon", "amplify-button" ], "amplify-picker": [ "amplify-button" ], "amplify-button": [ "amplify-icon" ], "amplify-s3-image-picker": [ "amplify-photo-picker" ] } }, { "filePath": "./src/components/amplify-picker/amplify-picker.tsx", "encapsulation": "shadow", "tag": "amplify-picker", "readme": "# amplify-picker\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "acceptValue", "type": "string", "mutable": false, "attr": "accept-value", "reflectToAttr": false, "docs": "File input accept value", "docsTags": [], "default": "'*/*'", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "inputHandler", "type": "(e: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "File input onChange handler", "docsTags": [], "values": [ { "type": "(e: Event) => void" } ], "optional": false, "required": false }, { "name": "pickerText", "type": "string", "mutable": false, "attr": "picker-text", "reflectToAttr": false, "docs": "Picker button text", "docsTags": [], "default": "Translations.PICKER_TEXT", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-photo-picker", "amplify-s3-album", "amplify-s3-text-picker" ], "dependencies": [ "amplify-button" ], "dependencyGraph": { "amplify-picker": [ "amplify-button" ], "amplify-button": [ "amplify-icon" ], "amplify-photo-picker": [ "amplify-picker" ], "amplify-s3-album": [ "amplify-picker" ], "amplify-s3-text-picker": [ "amplify-picker" ] } }, { "filePath": "./src/components/amplify-radio-button/amplify-radio-button.tsx", "encapsulation": "none", "tag": "amplify-radio-button", "readme": "# amplify-radio-button\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "checked", "type": "boolean", "mutable": false, "attr": "checked", "reflectToAttr": false, "docs": "If `true`, the radio button is selected.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "If `true`, the checkbox is disabled", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "fieldId", "type": "string", "mutable": false, "attr": "field-id", "reflectToAttr": false, "docs": "Field ID used for the 'for' in the label", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleInputChange", "type": "(inputEvent: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "The callback, called when the input is modified by the user.", "docsTags": [], "values": [ { "type": "(inputEvent: Event) => void" } ], "optional": true, "required": false }, { "name": "inputProps", "type": "object", "mutable": false, "reflectToAttr": false, "docs": "Attributes places on the input element: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes", "docsTags": [], "values": [ { "type": "object" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Label for the radio button", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "(Optional) Name of radio button", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "placeholder", "type": "string", "mutable": false, "attr": "placeholder", "reflectToAttr": false, "docs": "(Optional) The placeholder for the input element. Using hints is recommended, but placeholders can also be useful to convey information to users.", "docsTags": [], "default": "''", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "value", "type": "string", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "(Optional) Value of radio button", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-select-mfa-type", "amplify-verify-contact" ], "dependencies": [ "amplify-label" ], "dependencyGraph": { "amplify-radio-button": [ "amplify-label" ], "amplify-select-mfa-type": [ "amplify-radio-button" ], "amplify-verify-contact": [ "amplify-radio-button" ] } }, { "filePath": "./src/components/amplify-require-new-password/amplify-require-new-password.tsx", "encapsulation": "shadow", "tag": "amplify-require-new-password", "readme": "# amplify-require-new-password\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "formFields", "type": "FormFieldTypes", "mutable": false, "reflectToAttr": false, "docs": "The form fields displayed inside of the forgot password form", "docsTags": [], "default": "[\n\t\t{\n\t\t\ttype: AuthFormField.Password,\n\t\t\trequired: true,\n\t\t\thandleInputChange: event => this.handlePasswordChange(event),\n\t\t\tlabel: I18n.get(Translations.NEW_PASSWORD_LABEL),\n\t\t\tplaceholder: I18n.get(Translations.NEW_PASSWORD_PLACEHOLDER),\n\t\t\tinputProps: {\n\t\t\t\t'data-test': 'require-new-password-password-input',\n\t\t\t},\n\t\t},\n\t]", "values": [ { "type": "FormFieldTypes" } ], "optional": false, "required": false }, { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this component", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false }, { "name": "handleSubmit", "type": "(event: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "The function called when submitting a new password", "docsTags": [], "default": "event =>\n\t\tthis.completeNewPassword(event)", "values": [ { "type": "(event: Event) => void" } ], "optional": false, "required": false }, { "name": "headerText", "type": "string", "mutable": false, "attr": "header-text", "reflectToAttr": false, "docs": "The header text of the forgot password section", "docsTags": [], "default": "Translations.CHANGE_PASSWORD", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "submitButtonText", "type": "string", "mutable": false, "attr": "submit-button-text", "reflectToAttr": false, "docs": "The text displayed inside of the submit button for the form", "docsTags": [], "default": "Translations.CHANGE_PASSWORD_ACTION", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "user", "type": "CognitoUserInterface", "mutable": false, "reflectToAttr": false, "docs": "Used for the username to be passed to resend code", "docsTags": [], "values": [ { "type": "CognitoUserInterface" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-authenticator" ], "dependencies": [ "amplify-form-section", "amplify-button", "amplify-auth-fields" ], "dependencyGraph": { "amplify-require-new-password": [ "amplify-form-section", "amplify-button", "amplify-auth-fields" ], "amplify-form-section": [ "amplify-section", "amplify-button", "amplify-loading-spinner" ], "amplify-button": [ "amplify-icon" ], "amplify-loading-spinner": [ "amplify-icon" ], "amplify-auth-fields": [ "amplify-username-field", "amplify-password-field", "amplify-email-field", "amplify-code-field", "amplify-phone-field", "amplify-form-field" ], "amplify-username-field": [ "amplify-form-field" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-password-field": [ "amplify-form-field" ], "amplify-email-field": [ "amplify-form-field" ], "amplify-code-field": [ "amplify-form-field" ], "amplify-phone-field": [ "amplify-form-field", "amplify-country-dial-code", "amplify-input" ], "amplify-country-dial-code": [ "amplify-select" ], "amplify-authenticator": [ "amplify-require-new-password" ] } }, { "filePath": "./src/components/amplify-s3-album/amplify-s3-album.tsx", "encapsulation": "shadow", "tag": "amplify-s3-album", "readme": "# amplify-s3-album\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "contentType", "type": "string", "mutable": false, "attr": "content-type", "reflectToAttr": false, "docs": "The content type header used when uploading to S3", "docsTags": [], "default": "'binary/octet-stream'", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "fileToKey", "type": "(data: object) => string", "mutable": false, "reflectToAttr": false, "docs": "Callback used to generate custom key value", "docsTags": [], "values": [ { "type": "(data: object) => string" } ], "optional": false, "required": false }, { "name": "filter", "type": "(list: StorageObject[]) => StorageObject[]", "mutable": false, "reflectToAttr": false, "docs": "Filter to be applied on album list", "docsTags": [], "values": [ { "type": "(list: StorageObject[]) => StorageObject[]" } ], "optional": false, "required": false }, { "name": "handleOnError", "type": "(event: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "Function executed when error occurs for the s3-image", "docsTags": [], "values": [ { "type": "(event: Event) => void" } ], "optional": false, "required": false }, { "name": "handleOnLoad", "type": "(event: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "Function executed when s3-image loads", "docsTags": [], "values": [ { "type": "(event: Event) => void" } ], "optional": false, "required": false }, { "name": "identityId", "type": "string", "mutable": false, "attr": "identity-id", "reflectToAttr": false, "docs": "Cognito identity id of the another user's image list", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "level", "type": "AccessLevel.Private | AccessLevel.Protected | AccessLevel.Public", "mutable": false, "attr": "level", "reflectToAttr": false, "docs": "The access level of the files", "docsTags": [], "default": "AccessLevel.Public", "values": [ { "type": "AccessLevel.Private" }, { "type": "AccessLevel.Protected" }, { "type": "AccessLevel.Public" } ], "optional": false, "required": false }, { "name": "path", "type": "string", "mutable": false, "attr": "path", "reflectToAttr": false, "docs": "String representing directory location of image files to be listed", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "picker", "type": "boolean", "mutable": false, "attr": "picker", "reflectToAttr": false, "docs": "Boolean to enable or disable picker", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "pickerText", "type": "string", "mutable": false, "attr": "picker-text", "reflectToAttr": false, "docs": "Picker button text", "docsTags": [], "default": "Translations.PICKER_TEXT", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "sort", "type": "(list: StorageObject[]) => StorageObject[]", "mutable": false, "reflectToAttr": false, "docs": "Sort to be applied on album list", "docsTags": [], "values": [ { "type": "(list: StorageObject[]) => StorageObject[]" } ], "optional": false, "required": false }, { "name": "track", "type": "boolean", "mutable": false, "attr": "track", "reflectToAttr": false, "docs": "Whether or not to use track the get/put of the listing of images", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--overlay-bg-color", "annotation": "prop", "docs": "Image overlay color on hover" } ], "slots": [], "parts": [], "dependents": [], "dependencies": [ "amplify-s3-image", "amplify-picker" ], "dependencyGraph": { "amplify-s3-album": [ "amplify-s3-image", "amplify-picker" ], "amplify-picker": [ "amplify-button" ], "amplify-button": [ "amplify-icon" ] } }, { "filePath": "./src/components/amplify-s3-image/amplify-s3-image.tsx", "encapsulation": "shadow", "tag": "amplify-s3-image", "readme": "# amplify-s3-image\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "alt", "type": "string", "mutable": false, "attr": "alt", "reflectToAttr": false, "docs": "String representing the alternate image text", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "body", "type": "object", "mutable": false, "reflectToAttr": false, "docs": "Image body content to be uploaded", "docsTags": [], "values": [ { "type": "object" } ], "optional": false, "required": false }, { "name": "contentType", "type": "string", "mutable": false, "attr": "content-type", "reflectToAttr": false, "docs": "The content type header used when uploading to S3", "docsTags": [], "default": "'binary/octet-stream'", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleOnError", "type": "(event: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "Function executed when error occurs for the image", "docsTags": [], "values": [ { "type": "(event: Event) => void" } ], "optional": false, "required": false }, { "name": "handleOnLoad", "type": "(event: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "Function executed when image loads", "docsTags": [], "values": [ { "type": "(event: Event) => void" } ], "optional": false, "required": false }, { "name": "identityId", "type": "string", "mutable": false, "attr": "identity-id", "reflectToAttr": false, "docs": "Cognito identity id of the another user's image", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "imgKey", "type": "string", "mutable": false, "attr": "img-key", "reflectToAttr": false, "docs": "The key of the image object in S3", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "imgProps", "type": "{ [x: string]: any; [x: number]: any; }", "mutable": false, "reflectToAttr": false, "docs": "Attributes to be placed on the img element: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attributes", "docsTags": [], "values": [ { "type": "{ [x: string]: any; [x: number]: any; }" } ], "optional": true, "required": false }, { "name": "level", "type": "AccessLevel.Private | AccessLevel.Protected | AccessLevel.Public", "mutable": false, "attr": "level", "reflectToAttr": false, "docs": "The access level of the image", "docsTags": [], "default": "AccessLevel.Public", "values": [ { "type": "AccessLevel.Private" }, { "type": "AccessLevel.Protected" }, { "type": "AccessLevel.Public" } ], "optional": false, "required": false }, { "name": "path", "type": "string", "mutable": false, "attr": "path", "reflectToAttr": false, "docs": "String representing directory location to image file", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "track", "type": "boolean", "mutable": false, "attr": "track", "reflectToAttr": false, "docs": "Whether or not to use track on get/put of the image", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--height", "annotation": "prop", "docs": "Image height" }, { "name": "--width", "annotation": "prop", "docs": "Image width" } ], "slots": [], "parts": [], "dependents": [ "amplify-s3-album" ], "dependencies": [], "dependencyGraph": { "amplify-s3-album": [ "amplify-s3-image" ] } }, { "filePath": "./src/components/amplify-s3-image-picker/amplify-s3-image-picker.tsx", "encapsulation": "none", "tag": "amplify-s3-image-picker", "readme": "# amplify-s3-image-picker\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "buttonText", "type": "string", "mutable": false, "attr": "button-text", "reflectToAttr": false, "docs": "Upload Button Text as string", "docsTags": [], "default": "Translations.IMAGE_PICKER_BUTTON_TEXT", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "contentType", "type": "string", "mutable": false, "attr": "content-type", "reflectToAttr": false, "docs": "The content type header used when uploading to S3", "docsTags": [], "default": "'binary/octet-stream'", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "fileToKey", "type": "(data: object) => string", "mutable": false, "reflectToAttr": false, "docs": "Callback used to generate custom key value", "docsTags": [], "values": [ { "type": "(data: object) => string" } ], "optional": false, "required": false }, { "name": "headerHint", "type": "string", "mutable": false, "attr": "header-hint", "reflectToAttr": false, "docs": "Header Hint value in string", "docsTags": [], "default": "Translations.IMAGE_PICKER_HINT", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "headerTitle", "type": "string", "mutable": false, "attr": "header-title", "reflectToAttr": false, "docs": "Title string value", "docsTags": [], "default": "Translations.IMAGE_PICKER_TITLE", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "identityId", "type": "string", "mutable": false, "attr": "identity-id", "reflectToAttr": false, "docs": "Cognito identity id of the another user's image", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "level", "type": "AccessLevel.Private | AccessLevel.Protected | AccessLevel.Public", "mutable": false, "attr": "level", "reflectToAttr": false, "docs": "The access level of the image", "docsTags": [], "default": "AccessLevel.Public", "values": [ { "type": "AccessLevel.Private" }, { "type": "AccessLevel.Protected" }, { "type": "AccessLevel.Public" } ], "optional": false, "required": false }, { "name": "path", "type": "string", "mutable": false, "attr": "path", "reflectToAttr": false, "docs": "String representing directory location to image file", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "placeholderHint", "type": "string", "mutable": false, "attr": "placeholder-hint", "reflectToAttr": false, "docs": "Placeholder hint that goes under the placeholder image", "docsTags": [], "default": "Translations.IMAGE_PICKER_PLACEHOLDER_HINT", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "track", "type": "boolean", "mutable": false, "attr": "track", "reflectToAttr": false, "docs": "Whether or not to use track the get/put of the image", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "amplify-photo-picker" ], "dependencyGraph": { "amplify-s3-image-picker": [ "amplify-photo-picker" ], "amplify-photo-picker": [ "amplify-section", "amplify-picker", "amplify-icon", "amplify-button" ], "amplify-picker": [ "amplify-button" ], "amplify-button": [ "amplify-icon" ] } }, { "filePath": "./src/components/amplify-s3-text/amplify-s3-text.tsx", "encapsulation": "shadow", "tag": "amplify-s3-text", "readme": "# amplify-s3-text\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "body", "type": "object", "mutable": false, "reflectToAttr": false, "docs": "Text body content to be uploaded", "docsTags": [], "values": [ { "type": "object" } ], "optional": false, "required": false }, { "name": "contentType", "type": "string", "mutable": false, "attr": "content-type", "reflectToAttr": false, "docs": "The content type header used when uploading to S3", "docsTags": [], "default": "'text/*'", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "fallbackText", "type": "string", "mutable": false, "attr": "fallback-text", "reflectToAttr": false, "docs": "Fallback content", "docsTags": [], "default": "Translations.TEXT_FALLBACK_CONTENT", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "identityId", "type": "string", "mutable": false, "attr": "identity-id", "reflectToAttr": false, "docs": "Cognito identity id of the another user's text file", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "level", "type": "AccessLevel.Private | AccessLevel.Protected | AccessLevel.Public", "mutable": false, "attr": "level", "reflectToAttr": false, "docs": "The access level of the text file", "docsTags": [], "default": "AccessLevel.Public", "values": [ { "type": "AccessLevel.Private" }, { "type": "AccessLevel.Protected" }, { "type": "AccessLevel.Public" } ], "optional": false, "required": false }, { "name": "path", "type": "string", "mutable": false, "attr": "path", "reflectToAttr": false, "docs": "String representing directory location to text file", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "textKey", "type": "string", "mutable": false, "attr": "text-key", "reflectToAttr": false, "docs": "The key of the text object in S3", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "track", "type": "boolean", "mutable": false, "attr": "track", "reflectToAttr": false, "docs": "Whether or not to use track the get/put of the text file", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--border-color", "annotation": "prop", "docs": "Border color of the text container" }, { "name": "--container-color", "annotation": "prop", "docs": "Background color of the text container" }, { "name": "--font-size", "annotation": "prop", "docs": "Font size of the text" }, { "name": "--text-color", "annotation": "prop", "docs": "Font color of the text" } ], "slots": [], "parts": [], "dependents": [ "amplify-s3-text-picker" ], "dependencies": [], "dependencyGraph": { "amplify-s3-text-picker": [ "amplify-s3-text" ] } }, { "filePath": "./src/components/amplify-s3-text-picker/amplify-s3-text-picker.tsx", "encapsulation": "shadow", "tag": "amplify-s3-text-picker", "readme": "# amplify-s3-text-picker\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "contentType", "type": "string", "mutable": false, "attr": "content-type", "reflectToAttr": false, "docs": "The content type header used when uploading to S3", "docsTags": [], "default": "'text/*'", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "fallbackText", "type": "string", "mutable": false, "attr": "fallback-text", "reflectToAttr": false, "docs": "Fallback content for aplify-s3-text", "docsTags": [], "default": "Translations.PICKER_TEXT", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "fileToKey", "type": "(data: object) => string", "mutable": false, "reflectToAttr": false, "docs": "Callback used to generate custom key value", "docsTags": [], "values": [ { "type": "(data: object) => string" } ], "optional": false, "required": false }, { "name": "identityId", "type": "string", "mutable": false, "attr": "identity-id", "reflectToAttr": false, "docs": "Cognito identity id of the another user's text file", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "level", "type": "AccessLevel.Private | AccessLevel.Protected | AccessLevel.Public", "mutable": false, "attr": "level", "reflectToAttr": false, "docs": "The access level of the text file", "docsTags": [], "default": "AccessLevel.Public", "values": [ { "type": "AccessLevel.Private" }, { "type": "AccessLevel.Protected" }, { "type": "AccessLevel.Public" } ], "optional": false, "required": false }, { "name": "path", "type": "string", "mutable": false, "attr": "path", "reflectToAttr": false, "docs": "String representing directory location to text file", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "track", "type": "boolean", "mutable": false, "attr": "track", "reflectToAttr": false, "docs": "Whether or not to use track the get/put of the text file", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "amplify-s3-text", "amplify-picker" ], "dependencyGraph": { "amplify-s3-text-picker": [ "amplify-s3-text", "amplify-picker" ], "amplify-picker": [ "amplify-button" ], "amplify-button": [ "amplify-icon" ] } }, { "filePath": "./src/components/amplify-section/amplify-section.tsx", "encapsulation": "none", "tag": "amplify-section", "readme": "# amplify-section\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "role", "type": "string", "mutable": false, "attr": "role", "reflectToAttr": false, "docs": "Equivalent to html section role", "docsTags": [], "default": "'application'", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--background-color", "annotation": "prop", "docs": "Background color of the container" }, { "name": "--font-family", "annotation": "prop", "docs": "Font family of the text within the container" } ], "slots": [], "parts": [], "dependents": [ "amplify-federated-sign-in", "amplify-form-section", "amplify-photo-picker" ], "dependencies": [], "dependencyGraph": { "amplify-federated-sign-in": [ "amplify-section" ], "amplify-form-section": [ "amplify-section" ], "amplify-photo-picker": [ "amplify-section" ] } }, { "filePath": "./src/components/amplify-select/amplify-select.tsx", "encapsulation": "shadow", "tag": "amplify-select", "readme": "# amplify-select\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "fieldId", "type": "string", "mutable": false, "attr": "field-id", "reflectToAttr": false, "docs": "Used for id field", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleInputChange", "type": "(inputEvent: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "The callback, called when the select is modified by the user.", "docsTags": [], "values": [ { "type": "(inputEvent: Event) => void" } ], "optional": true, "required": false }, { "name": "options", "type": "SelectOptions | SelectOptions", "mutable": false, "reflectToAttr": false, "docs": "The options of the select input. Must be an Array of Objects with an Object shape of {label: string, value: string|number}", "docsTags": [], "default": "DEFAULT_SELECT_OPTION", "values": [ { "type": "SelectOptions" }, { "type": "SelectOptions" } ], "optional": false, "required": false }, { "name": "selected", "type": "number | string", "mutable": false, "attr": "selected", "reflectToAttr": false, "docs": "Default selected option", "docsTags": [], "values": [ { "type": "number" }, { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--background-color", "annotation": "prop", "docs": "Background color of the input container" }, { "name": "--background-image", "annotation": "prop", "docs": "Image of the icon displayed next to text. Defaults to an upside down triangle." }, { "name": "--border-color", "annotation": "prop", "docs": "Border color of the input container" }, { "name": "--border-focus", "annotation": "prop", "docs": "Border color of the input container when focused on" }, { "name": "--color", "annotation": "prop", "docs": "Text color of the select choices" } ], "slots": [], "parts": [], "dependents": [ "amplify-country-dial-code" ], "dependencies": [], "dependencyGraph": { "amplify-country-dial-code": [ "amplify-select" ] } }, { "filePath": "./src/components/amplify-select-mfa-type/amplify-select-mfa-type.tsx", "encapsulation": "shadow", "tag": "amplify-select-mfa-type", "readme": "# amplify-totp\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "MFATypes", "type": "MFATypesInterface", "mutable": false, "reflectToAttr": false, "docs": "Types of MFA options", "docsTags": [], "values": [ { "type": "MFATypesInterface" } ], "optional": false, "required": false }, { "name": "authData", "type": "CognitoUserInterface", "mutable": false, "reflectToAttr": false, "docs": "Current authenticated user in order to sign requests properly for TOTP", "docsTags": [], "values": [ { "type": "CognitoUserInterface" } ], "optional": false, "required": false }, { "name": "handleSubmit", "type": "(event: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "Fires when Verify is clicked", "docsTags": [], "default": "event => this.verify(event)", "values": [ { "type": "(event: Event) => void" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "amplify-form-section", "amplify-radio-button", "amplify-toast", "amplify-totp-setup" ], "dependencyGraph": { "amplify-select-mfa-type": [ "amplify-form-section", "amplify-radio-button", "amplify-toast", "amplify-totp-setup" ], "amplify-form-section": [ "amplify-section", "amplify-button", "amplify-loading-spinner" ], "amplify-button": [ "amplify-icon" ], "amplify-loading-spinner": [ "amplify-icon" ], "amplify-radio-button": [ "amplify-label" ], "amplify-toast": [ "amplify-icon" ], "amplify-totp-setup": [ "amplify-form-section", "amplify-form-field" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ] } }, { "filePath": "./src/components/amplify-sign-in/amplify-sign-in.tsx", "encapsulation": "shadow", "tag": "amplify-sign-in", "readme": "# amplify-sign-in\n", "docs": "", "docsTags": [ { "text": "header-subtitle - Subtitle content placed below header text", "name": "slot" }, { "text": "federated-buttons - Content above form fields used for sign in federation buttons", "name": "slot" }, { "text": "footer - Content is place in the footer of the component", "name": "slot" }, { "text": "primary-footer-content - Content placed on the right side of the footer", "name": "slot" }, { "text": "secondary-footer-content - Content placed on the left side of the footer", "name": "slot" } ], "usage": {}, "props": [ { "name": "federated", "type": "FederatedConfig", "mutable": false, "reflectToAttr": false, "docs": "Federated credentials & configuration.", "docsTags": [], "values": [ { "type": "FederatedConfig" } ], "optional": false, "required": false }, { "name": "formFields", "type": "FormFieldTypes | string[]", "mutable": false, "reflectToAttr": false, "docs": "Form fields allows you to utilize our pre-built components such as username field, code field, password field, email field, etc.\nby passing an array of strings that you would like the order of the form to be in. If you need more customization, such as changing\ntext for a label or adjust a placeholder, you can follow the structure below in order to do just that.\n```\n[\n {\n type: string,\n label: string,\n placeholder: string,\n hint: string | Functional Component | null,\n required: boolean\n }\n]\n```", "docsTags": [], "default": "[]", "values": [ { "type": "FormFieldTypes" }, { "type": "string[]" } ], "optional": false, "required": false }, { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this component", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false }, { "name": "handleSubmit", "type": "(event: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "Fires when sign in form is submitted", "docsTags": [], "default": "event => this.signIn(event)", "values": [ { "type": "(event: Event) => void" } ], "optional": false, "required": false }, { "name": "headerText", "type": "string", "mutable": false, "attr": "header-text", "reflectToAttr": false, "docs": "Used for header text in sign in component", "docsTags": [], "default": "Translations.SIGN_IN_HEADER_TEXT", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "hideSignUp", "type": "boolean", "mutable": false, "attr": "hide-sign-up", "reflectToAttr": false, "docs": "Hides the sign up link", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "submitButtonText", "type": "string", "mutable": false, "attr": "submit-button-text", "reflectToAttr": false, "docs": "Used for the submit button text in sign in component", "docsTags": [], "default": "Translations.SIGN_IN_ACTION", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "usernameAlias", "type": "\"email\" | \"phone_number\" | \"username\"", "mutable": false, "attr": "username-alias", "reflectToAttr": false, "docs": "Username Alias is used to setup authentication with `username`, `email` or `phone_number`", "docsTags": [], "default": "'username'", "values": [ { "value": "email", "type": "string" }, { "value": "phone_number", "type": "string" }, { "value": "username", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--footer-color", "annotation": "prop", "docs": "Font color of the footer" }, { "name": "--footer-font-family", "annotation": "prop", "docs": "Font family of the footer" }, { "name": "--footer-font-size", "annotation": "prop", "docs": "Font size of the footer" }, { "name": "--footer-weight", "annotation": "prop", "docs": "Font weight of the footer" } ], "slots": [ { "name": "federated-buttons", "docs": "Content above form fields used for sign in federation buttons" }, { "name": "footer", "docs": "Content is place in the footer of the component" }, { "name": "header-subtitle", "docs": "Subtitle content placed below header text" }, { "name": "primary-footer-content", "docs": "Content placed on the right side of the footer" }, { "name": "secondary-footer-content", "docs": "Content placed on the left side of the footer" } ], "parts": [], "dependents": [ "amplify-authenticator" ], "dependencies": [ "amplify-button", "amplify-form-section", "amplify-federated-buttons", "amplify-strike", "amplify-auth-fields", "amplify-loading-spinner" ], "dependencyGraph": { "amplify-sign-in": [ "amplify-button", "amplify-form-section", "amplify-federated-buttons", "amplify-strike", "amplify-auth-fields", "amplify-loading-spinner" ], "amplify-button": [ "amplify-icon" ], "amplify-form-section": [ "amplify-section", "amplify-button", "amplify-loading-spinner" ], "amplify-loading-spinner": [ "amplify-icon" ], "amplify-federated-buttons": [ "amplify-google-button", "amplify-facebook-button", "amplify-amazon-button", "amplify-oauth-button", "amplify-auth0-button" ], "amplify-google-button": [ "amplify-sign-in-button" ], "amplify-sign-in-button": [ "amplify-icon" ], "amplify-facebook-button": [ "amplify-sign-in-button" ], "amplify-amazon-button": [ "amplify-sign-in-button" ], "amplify-oauth-button": [ "amplify-sign-in-button" ], "amplify-auth0-button": [ "amplify-sign-in-button" ], "amplify-auth-fields": [ "amplify-username-field", "amplify-password-field", "amplify-email-field", "amplify-code-field", "amplify-phone-field", "amplify-form-field" ], "amplify-username-field": [ "amplify-form-field" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-password-field": [ "amplify-form-field" ], "amplify-email-field": [ "amplify-form-field" ], "amplify-code-field": [ "amplify-form-field" ], "amplify-phone-field": [ "amplify-form-field", "amplify-country-dial-code", "amplify-input" ], "amplify-country-dial-code": [ "amplify-select" ], "amplify-authenticator": [ "amplify-sign-in" ] } }, { "filePath": "./src/components/amplify-sign-in-button/amplify-sign-in-button.tsx", "encapsulation": "scoped", "tag": "amplify-sign-in-button", "readme": "# amplify-sign-in-button\n", "docs": "", "docsTags": [ { "text": "(default) - Content placed inside the button", "name": "slot" } ], "usage": {}, "props": [ { "name": "provider", "type": "\"amazon\" | \"auth0\" | \"facebook\" | \"google\" | \"oauth\"", "mutable": false, "attr": "provider", "reflectToAttr": false, "docs": "Specifies the federation provider.", "docsTags": [], "values": [ { "value": "amazon", "type": "string" }, { "value": "auth0", "type": "string" }, { "value": "facebook", "type": "string" }, { "value": "google", "type": "string" }, { "value": "oauth", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "(default)", "docs": "Content placed inside the button" } ], "parts": [], "dependents": [ "amplify-amazon-button", "amplify-auth0-button", "amplify-facebook-button", "amplify-google-button", "amplify-oauth-button" ], "dependencies": [ "amplify-icon" ], "dependencyGraph": { "amplify-sign-in-button": [ "amplify-icon" ], "amplify-amazon-button": [ "amplify-sign-in-button" ], "amplify-auth0-button": [ "amplify-sign-in-button" ], "amplify-facebook-button": [ "amplify-sign-in-button" ], "amplify-google-button": [ "amplify-sign-in-button" ], "amplify-oauth-button": [ "amplify-sign-in-button" ] } }, { "filePath": "./src/components/amplify-sign-out/amplify-sign-out.tsx", "encapsulation": "shadow", "tag": "amplify-sign-out", "readme": "# amplify-sign-out\n", "docs": "", "docsTags": [ { "text": "sign-out - The sign out button element", "name": "slot" } ], "usage": {}, "props": [ { "name": "buttonText", "type": "string", "mutable": false, "attr": "button-text", "reflectToAttr": false, "docs": "Text inside of the Sign Out button", "docsTags": [], "default": "Translations.SIGN_OUT", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this component", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "sign-out", "docs": "The sign out button element" } ], "parts": [], "dependents": [ "amplify-greetings" ], "dependencies": [ "amplify-button" ], "dependencyGraph": { "amplify-sign-out": [ "amplify-button" ], "amplify-button": [ "amplify-icon" ], "amplify-greetings": [ "amplify-sign-out" ] } }, { "filePath": "./src/components/amplify-sign-up/amplify-sign-up.tsx", "encapsulation": "shadow", "tag": "amplify-sign-up", "readme": "# amplify-sign-up\n", "docs": "", "docsTags": [ { "text": "header-subtitle - Subtitle content placed below header text", "name": "slot" }, { "text": "footer - Content placed in the footer of the component", "name": "slot" }, { "text": "primary-footer-content - Content placed on the right side of the footer", "name": "slot" }, { "text": "secondary-footer-content - Content placed on the left side of the footer", "name": "slot" } ], "usage": {}, "props": [ { "name": "formFields", "type": "FormFieldTypes | string[]", "mutable": false, "reflectToAttr": false, "docs": "Form fields allows you to utilize our pre-built components such as username field, code field, password field, email field, etc.\nby passing an array of strings that you would like the order of the form to be in. If you need more customization, such as changing\ntext for a label or adjust a placeholder, you can follow the structure below in order to do just that.\n```\n[\n {\n type: string,\n label: string,\n placeholder: string,\n hint: string | Functional Component | null,\n required: boolean\n }\n]\n```", "docsTags": [], "default": "[]", "values": [ { "type": "FormFieldTypes" }, { "type": "string[]" } ], "optional": false, "required": false }, { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this component\ne.g. SignIn -> 'Create Account' link -> SignUp", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false }, { "name": "handleSignUp", "type": "(params: SignUpParams) => Promise", "mutable": false, "reflectToAttr": false, "docs": "Override for handling the Auth.SignUp API call", "docsTags": [], "default": "params => this.authSignUp(params)", "values": [ { "type": "(params: SignUpParams) => Promise" } ], "optional": false, "required": false }, { "name": "handleSubmit", "type": "(event: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "Fires when sign up form is submitted", "docsTags": [], "default": "event => this.signUp(event)", "values": [ { "type": "(event: Event) => void" } ], "optional": false, "required": false }, { "name": "haveAccountText", "type": "string", "mutable": false, "attr": "have-account-text", "reflectToAttr": false, "docs": "Used for the submit button text in sign up component", "docsTags": [], "default": "Translations.SIGN_UP_HAVE_ACCOUNT_TEXT", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "headerText", "type": "string", "mutable": false, "attr": "header-text", "reflectToAttr": false, "docs": "Used for header text in sign up component", "docsTags": [], "default": "Translations.SIGN_UP_HEADER_TEXT", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "signInText", "type": "string", "mutable": false, "attr": "sign-in-text", "reflectToAttr": false, "docs": "Text used for the sign in hyperlink", "docsTags": [], "default": "Translations.SIGN_IN_TEXT", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "submitButtonText", "type": "string", "mutable": false, "attr": "submit-button-text", "reflectToAttr": false, "docs": "Used for the submit button text in sign up component", "docsTags": [], "default": "Translations.SIGN_UP_SUBMIT_BUTTON_TEXT", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "usernameAlias", "type": "\"email\" | \"phone_number\" | \"username\"", "mutable": false, "attr": "username-alias", "reflectToAttr": false, "docs": "Username Alias is used to setup authentication with `username`, `email` or `phone_number`", "docsTags": [], "default": "'username'", "values": [ { "value": "email", "type": "string" }, { "value": "phone_number", "type": "string" }, { "value": "username", "type": "string" } ], "optional": false, "required": false }, { "name": "validationErrors", "type": "string", "mutable": false, "attr": "validation-errors", "reflectToAttr": false, "docs": "Engages when invalid actions occur, such as missing field, etc.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--footer-color", "annotation": "prop", "docs": "Font color of the footer" }, { "name": "--footer-font-family", "annotation": "prop", "docs": "Font family of the footer" }, { "name": "--footer-font-size", "annotation": "prop", "docs": "Font size of the footer" }, { "name": "--footer-weight", "annotation": "prop", "docs": "Font weight of the footer" } ], "slots": [ { "name": "footer", "docs": "Content placed in the footer of the component" }, { "name": "header-subtitle", "docs": "Subtitle content placed below header text" }, { "name": "primary-footer-content", "docs": "Content placed on the right side of the footer" }, { "name": "secondary-footer-content", "docs": "Content placed on the left side of the footer" } ], "parts": [], "dependents": [ "amplify-authenticator" ], "dependencies": [ "amplify-form-section", "amplify-auth-fields", "amplify-button", "amplify-loading-spinner" ], "dependencyGraph": { "amplify-sign-up": [ "amplify-form-section", "amplify-auth-fields", "amplify-button", "amplify-loading-spinner" ], "amplify-form-section": [ "amplify-section", "amplify-button", "amplify-loading-spinner" ], "amplify-button": [ "amplify-icon" ], "amplify-loading-spinner": [ "amplify-icon" ], "amplify-auth-fields": [ "amplify-username-field", "amplify-password-field", "amplify-email-field", "amplify-code-field", "amplify-phone-field", "amplify-form-field" ], "amplify-username-field": [ "amplify-form-field" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-password-field": [ "amplify-form-field" ], "amplify-email-field": [ "amplify-form-field" ], "amplify-code-field": [ "amplify-form-field" ], "amplify-phone-field": [ "amplify-form-field", "amplify-country-dial-code", "amplify-input" ], "amplify-country-dial-code": [ "amplify-select" ], "amplify-authenticator": [ "amplify-sign-up" ] } }, { "filePath": "./src/components/amplify-strike/amplify-strike.tsx", "encapsulation": "scoped", "tag": "amplify-strike", "readme": "# amplify-strike\n", "docs": "", "docsTags": [ { "text": "(default) - Content placed between the two horizontal rules", "name": "slot" } ], "usage": {}, "props": [], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--border-color", "annotation": "prop", "docs": "Color of the horizontal rules" }, { "name": "--color", "annotation": "prop", "docs": "Text color of the content placed between the horizontal rules" }, { "name": "--content-background", "annotation": "prop", "docs": "Background color of the container placed between the horizontal rules" } ], "slots": [ { "name": "(default)", "docs": "Content placed between the two horizontal rules" } ], "parts": [], "dependents": [ "amplify-sign-in" ], "dependencies": [], "dependencyGraph": { "amplify-sign-in": [ "amplify-strike" ] } }, { "filePath": "./src/components/amplify-toast/amplify-toast.tsx", "encapsulation": "shadow", "tag": "amplify-toast", "readme": "# amplify-toast\n", "docs": "", "docsTags": [ { "text": "(default) - Content placed inside the toast. If `message` prop is already set, then this content will be displayed to the right of the `message`.", "name": "slot" } ], "usage": {}, "props": [ { "name": "handleClose", "type": "() => void", "mutable": false, "reflectToAttr": false, "docs": "Used in order to add a dismissable `x` for the Toast component", "docsTags": [], "values": [ { "type": "() => void" } ], "optional": false, "required": false }, { "name": "message", "type": "string", "mutable": false, "attr": "message", "reflectToAttr": false, "docs": "Message to be displayed inside the toast", "docsTags": [], "default": "''", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--background-color", "annotation": "prop", "docs": "Background color of the container" }, { "name": "--close-icon-color", "annotation": "prop", "docs": "Fill color of the close icon" }, { "name": "--close-icon-hover", "annotation": "prop", "docs": "Fill color of the close icon when hovering" }, { "name": "--color", "annotation": "prop", "docs": "Text color within the toast" }, { "name": "--font-size", "annotation": "prop", "docs": "Font size of the text within the toast" } ], "slots": [ { "name": "(default)", "docs": "Content placed inside the toast. If `message` prop is already set, then this content will be displayed to the right of the `message`." } ], "parts": [], "dependents": [ "amplify-authenticator", "amplify-chatbot", "amplify-select-mfa-type" ], "dependencies": [ "amplify-icon" ], "dependencyGraph": { "amplify-toast": [ "amplify-icon" ], "amplify-authenticator": [ "amplify-toast" ], "amplify-chatbot": [ "amplify-toast" ], "amplify-select-mfa-type": [ "amplify-toast" ] } }, { "filePath": "./src/components/amplify-tooltip/amplify-tooltip.tsx", "encapsulation": "shadow", "tag": "amplify-tooltip", "readme": "# amplify-tooltip\n", "docs": "", "docsTags": [ { "text": "(default) - Text displayed below the tooltip. This will always be visible.", "name": "slot" } ], "usage": {}, "props": [ { "name": "shouldAutoShow", "type": "boolean", "mutable": false, "attr": "should-auto-show", "reflectToAttr": false, "docs": "(Optional) Whether or not the tooltip should be automatically shown, i.e. not disappear when not hovered", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "text", "type": "string", "mutable": false, "attr": "text", "reflectToAttr": false, "docs": "(Required) The text in the tooltip", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--background-color", "annotation": "prop", "docs": "Background color of the tooltip" }, { "name": "--border-color", "annotation": "prop", "docs": "Border color of the tooltip" }, { "name": "--color", "annotation": "prop", "docs": "Text color within the tooltip" }, { "name": "--font-family", "annotation": "prop", "docs": "Font family of the text placed within the tooltip" } ], "slots": [ { "name": "(default)", "docs": "Text displayed below the tooltip. This will always be visible." } ], "parts": [], "dependents": [ "amplify-icon-button" ], "dependencies": [], "dependencyGraph": { "amplify-icon-button": [ "amplify-tooltip" ] } }, { "filePath": "./src/components/amplify-totp-setup/amplify-totp-setup.tsx", "encapsulation": "shadow", "tag": "amplify-totp-setup", "readme": "# amplify-totp\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Auth state change handler for this component", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false }, { "name": "handleComplete", "type": "(user: CognitoUserInterface) => void | Promise", "mutable": false, "reflectToAttr": false, "docs": "This is run after totp setup is complete. Useful if using this as standalone.", "docsTags": [], "default": "this.onTOTPEvent", "values": [ { "type": "(user: CognitoUserInterface) => void" }, { "type": "Promise" } ], "optional": false, "required": false }, { "name": "headerText", "type": "string", "mutable": false, "attr": "header-text", "reflectToAttr": false, "docs": "Used for header text in totp setup component", "docsTags": [], "default": "Translations.TOTP_HEADER_TEXT", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "issuer", "type": "string", "mutable": false, "attr": "issuer", "reflectToAttr": false, "docs": "Used for customizing the issuer string in the qr code image", "docsTags": [], "default": "Translations.TOTP_ISSUER", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "standalone", "type": "boolean", "mutable": false, "attr": "standalone", "reflectToAttr": false, "docs": "Set this to true if this component is running outside the default `amplify-authenticator` usage", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "user", "type": "CognitoUserInterface", "mutable": false, "reflectToAttr": false, "docs": "Used in order to configure TOTP for a user", "docsTags": [], "values": [ { "type": "CognitoUserInterface" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-authenticator", "amplify-select-mfa-type" ], "dependencies": [ "amplify-form-section", "amplify-form-field" ], "dependencyGraph": { "amplify-totp-setup": [ "amplify-form-section", "amplify-form-field" ], "amplify-form-section": [ "amplify-section", "amplify-button", "amplify-loading-spinner" ], "amplify-button": [ "amplify-icon" ], "amplify-loading-spinner": [ "amplify-icon" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-authenticator": [ "amplify-totp-setup" ], "amplify-select-mfa-type": [ "amplify-totp-setup" ] } }, { "filePath": "./src/components/amplify-username-field/amplify-username-field.tsx", "encapsulation": "none", "tag": "amplify-username-field", "readme": "# amplify-username-field\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "Will disable the input if set to true", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "fieldId", "type": "string", "mutable": false, "attr": "field-id", "reflectToAttr": false, "docs": "Based on the type of field e.g. sign in, sign up, forgot password, etc.", "docsTags": [], "default": "USERNAME_SUFFIX", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "handleInputChange", "type": "(inputEvent: Event) => void", "mutable": false, "reflectToAttr": false, "docs": "The callback, called when the input is modified by the user.", "docsTags": [], "values": [ { "type": "(inputEvent: Event) => void" } ], "optional": true, "required": false }, { "name": "hint", "type": "FunctionalComponent<{}> | string", "mutable": false, "attr": "hint", "reflectToAttr": false, "docs": "Used for the hint text that displays underneath the input field", "docsTags": [], "values": [ { "type": "FunctionalComponent<{}>" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "inputProps", "type": "object", "mutable": false, "reflectToAttr": false, "docs": "Attributes places on the input element: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes", "docsTags": [], "values": [ { "type": "object" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Used for the username label", "docsTags": [], "default": "Translations.USERNAME_LABEL", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "placeholder", "type": "string", "mutable": false, "attr": "placeholder", "reflectToAttr": false, "docs": "Used for the placeholder label", "docsTags": [], "default": "Translations.USERNAME_PLACEHOLDER", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "mutable": false, "attr": "required", "reflectToAttr": false, "docs": "The required flag in order to make an input required prior to submitting a form", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The value of the content inside of the input field", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-auth-fields" ], "dependencies": [ "amplify-form-field" ], "dependencyGraph": { "amplify-username-field": [ "amplify-form-field" ], "amplify-form-field": [ "amplify-label", "amplify-input", "amplify-hint" ], "amplify-auth-fields": [ "amplify-username-field" ] } }, { "filePath": "./src/components/amplify-verify-contact/amplify-verify-contact.tsx", "encapsulation": "shadow", "tag": "amplify-verify-contact", "readme": "# amplify-verify-contact\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "handleAuthStateChange", "type": "(nextAuthState: AuthState, data?: object) => void", "mutable": false, "reflectToAttr": false, "docs": "Authentication state handler", "docsTags": [], "default": "dispatchAuthStateChangeEvent", "values": [ { "type": "(nextAuthState: AuthState, data?: object) => void" } ], "optional": false, "required": false }, { "name": "user", "type": "CognitoUserInterface", "mutable": false, "reflectToAttr": false, "docs": "User with unverified contact information", "docsTags": [], "values": [ { "type": "CognitoUserInterface" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "amplify-authenticator" ], "dependencies": [ "amplify-input", "amplify-radio-button", "amplify-form-section", "amplify-button" ], "dependencyGraph": { "amplify-verify-contact": [ "amplify-input", "amplify-radio-button", "amplify-form-section", "amplify-button" ], "amplify-radio-button": [ "amplify-label" ], "amplify-form-section": [ "amplify-section", "amplify-button", "amplify-loading-spinner" ], "amplify-button": [ "amplify-icon" ], "amplify-loading-spinner": [ "amplify-icon" ], "amplify-authenticator": [ "amplify-verify-contact" ] } } ] }