@supertokens-plugins/progressive-profiling-react
Type Aliases
FormInputComponentMap
type FormInputComponentMap = Record<BaseFormSection, React.FC<BaseFormSection<any>>>;
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/types.ts:27
SuperTokensPluginProfileProgressiveProfilingConfig
type SuperTokensPluginProfileProgressiveProfilingConfig = {
onSuccess?: (data: BaseFormSection) =>
| Promise<void>
| undefined;
requireSetup?: boolean;
setupPagePath?: string;
showEndSection?: boolean;
showStartSection?: boolean;
};
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/types.ts:6
Properties
SuperTokensPluginProfileProgressiveProfilingImplementation
type SuperTokensPluginProfileProgressiveProfilingImplementation = {
componentMap: () => FormInputComponentMap;
};
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/types.ts:22
Properties
SuperTokensPluginProfileProgressiveProfilingNormalisedConfig
type SuperTokensPluginProfileProgressiveProfilingNormalisedConfig = {
onSuccess?: (data: BaseFormSection) =>
| Promise<void>
| undefined;
requireSetup: boolean;
setupPagePath: string;
showEndSection: boolean;
showStartSection: boolean;
};
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/types.ts:14
Properties
TranslationKeys
type TranslationKeys = keyof typeof defaultTranslationsProgressiveProfiling["en"];
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/types.ts:26
Variables
API_PATH
const API_PATH: "plugin/supertokens-plugin-progressive-profiling";
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:22
default
default: {
init: any;
PLUGIN_ID: string;
PLUGIN_VERSION: string;
usePluginContext: any;
UserProfileWrapper: () => Element;
};
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/index.ts:7
Type Declaration
DEFAULT_FIELD_TYPE_COMPONENT_MAP
const DEFAULT_FIELD_TYPE_COMPONENT_MAP: FormInputComponentMap;
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:24
DEFAULT_REQUIRE_SETUP
const DEFAULT_REQUIRE_SETUP: true = true;
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:40
DEFAULT_SETUP_PAGE_PATH
const DEFAULT_SETUP_PAGE_PATH: "/user/setup" = "/user/setup";
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:41
DEFAULT_SHOW_END_SECTION
const DEFAULT_SHOW_END_SECTION: true = true;
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:44
DEFAULT_SHOW_START_SECTION
const DEFAULT_SHOW_START_SECTION: true = true;
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:43
defaultTranslationsProgressiveProfiling
const defaultTranslationsProgressiveProfiling: {
en: {
PL_PP_LOADING: "Loading...";
PL_PP_NO_SECTIONS: "No sections found";
PL_PP_PROFILE_SETUP_NOT_AVAILABLE: "The profile setup is not available";
PL_PP_SECTION_COMPLETE_BUTTON: "Complete";
PL_PP_SECTION_NEXT_BUTTON: "Next";
PL_PP_SECTION_PROFILE_END_DESCRIPTION: "You have completed the profile setup. You can now advance to the next step.";
PL_PP_SECTION_PROFILE_END_LABEL: "Profile";
PL_PP_SECTION_PROFILE_START_DESCRIPTION: "Before advancing any further, you will have to go through a quick {steps} step process for setting up your profile. This is only done once.";
PL_PP_SECTION_PROFILE_START_LABEL: "Profile";
PL_PP_SECTION_SAVE_AND_NEXT_BUTTON: "Save & Next";
};
};
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/translations.ts:1
Type Declaration
enableDebugLogs
enableDebugLogs: any;
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/logger.ts:5
init
const init: any;
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/plugin.ts:37
logDebugMessage
logDebugMessage: any;
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/logger.ts:5
PLUGIN_ID
const PLUGIN_ID: "supertokens-plugin-progressive-profiling" = "supertokens-plugin-progressive-profiling";
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:19
PLUGIN_VERSION
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/constants.ts:20
usePluginContext
usePluginContext: any;
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/plugin.ts:27
Functions
getApi()
function getApi(querier: any): {
getProfile: () => Promise<any>;
getSections: () => Promise<any>;
updateProfile: (payload: {
data: ProfileFormData;
}) => Promise<any>;
};
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/api.ts:4
Parameters
Returns
{
getProfile: () => Promise<any>;
getSections: () => Promise<any>;
updateProfile: (payload: {
data: ProfileFormData;
}) => Promise<any>;
}
PageWrapper()
function PageWrapper(__namedParameters: {
children: ReactNode;
style?: CSSProperties;
}): Element;
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/components/page-wrapper/page-wrapper.tsx:8
Parameters
Returns
Element
ProgressiveProfilingForm()
function ProgressiveProfilingForm(__namedParameters: ProgressiveProfilingFormProps): Element;
Parameters
Returns
Element
ProgressiveProfilingSetupPage()
function ProgressiveProfilingSetupPage(): Element;
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/progressive-profiling-setup-page.tsx:8
Returns
Element
ProgressiveProfilingWrapper()
function ProgressiveProfilingWrapper(): Element;
Defined in: supertokens-plugins/packages/progressive-profiling-react/src/progressive-profiling-wrapper.tsx:9
Returns
Element