propro-common-components 0.3.2 → 0.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
interface AuthLandingPageProps {
|
|
3
|
+
/**
|
|
4
|
+
* App name to display
|
|
5
|
+
*/
|
|
6
|
+
appName?: string;
|
|
7
|
+
/**
|
|
8
|
+
* App description or tagline
|
|
9
|
+
*/
|
|
10
|
+
description?: string;
|
|
11
|
+
/**
|
|
12
|
+
* Additional features/benefits to show
|
|
13
|
+
*/
|
|
14
|
+
features?: string[];
|
|
15
|
+
/**
|
|
16
|
+
* Logo component or image URL
|
|
17
|
+
*/
|
|
18
|
+
logo?: React.ReactNode;
|
|
19
|
+
/**
|
|
20
|
+
* Background image URL
|
|
21
|
+
*/
|
|
22
|
+
backgroundImage?: string;
|
|
23
|
+
/**
|
|
24
|
+
* Custom login button text
|
|
25
|
+
*/
|
|
26
|
+
loginButtonText?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Custom styles
|
|
29
|
+
*/
|
|
30
|
+
className?: string;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Landing page component for desktop apps
|
|
34
|
+
* Shows app info and a login button that opens browser for authentication
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```tsx
|
|
38
|
+
* import { AuthLandingPage } from 'propro-common-components';
|
|
39
|
+
*
|
|
40
|
+
* function DesktopEntry() {
|
|
41
|
+
* return (
|
|
42
|
+
* <AuthLandingPage
|
|
43
|
+
* appName="MapMap"
|
|
44
|
+
* description="Your visual workspace"
|
|
45
|
+
* features={["Organize", "Collaborate", "Create"]}
|
|
46
|
+
* />
|
|
47
|
+
* );
|
|
48
|
+
* }
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
export declare function AuthLandingPage({ appName, description, features, logo, backgroundImage, loginButtonText, className, }: AuthLandingPageProps): import("react/jsx-runtime").JSX.Element;
|
|
52
|
+
export {};
|