@jmruthers/pace-core 0.6.2 → 0.6.3
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.
- package/CHANGELOG.md +45 -0
- package/cursor-rules/00-pace-core-compliance.mdc +34 -2
- package/dist/{AuthService-BPvc3Ka0.d.ts → AuthService-Cb34EQs3.d.ts} +9 -1
- package/dist/{DataTable-TPTKCX4D.js → DataTable-THFPBKTP.js} +9 -8
- package/dist/{PublicPageProvider-DC6kCaqf.d.ts → PublicPageProvider-DEMpysFR.d.ts} +45 -67
- package/dist/{UnifiedAuthProvider-CVcTjx-d.d.ts → UnifiedAuthProvider-CKvHP1MK.d.ts} +1 -8
- package/dist/{UnifiedAuthProvider-CH6Z342H.js → UnifiedAuthProvider-KAGUYQ4J.js} +5 -4
- package/dist/{api-MVVQZLJI.js → api-IAGWF3ZG.js} +10 -10
- package/dist/{audit-B5P6FFIR.js → audit-V53FV5AG.js} +2 -2
- package/dist/{chunk-SFZUDBL5.js → chunk-2T2IG7T7.js} +70 -56
- package/dist/chunk-2T2IG7T7.js.map +1 -0
- package/dist/{chunk-MMZ7JXPU.js → chunk-6Z7LTB3D.js} +13 -21
- package/dist/{chunk-MMZ7JXPU.js.map → chunk-6Z7LTB3D.js.map} +1 -1
- package/dist/{chunk-6J4GEEJR.js → chunk-CNCQDFLN.js} +53 -27
- package/dist/chunk-CNCQDFLN.js.map +1 -0
- package/dist/chunk-DGUM43GV.js +11 -0
- package/dist/{chunk-EHMR7VYL.js → chunk-DWUBLJJM.js} +361 -187
- package/dist/chunk-DWUBLJJM.js.map +1 -0
- package/dist/{chunk-2UOI2FG5.js → chunk-HFZBI76P.js} +4 -4
- package/dist/{chunk-F2IMUDXZ.js → chunk-M7MPQISP.js} +2 -2
- package/dist/{chunk-3XC4CPTD.js → chunk-PQBSKX33.js} +244 -5727
- package/dist/chunk-PQBSKX33.js.map +1 -0
- package/dist/chunk-QRPVRXYT.js +226 -0
- package/dist/chunk-QRPVRXYT.js.map +1 -0
- package/dist/{chunk-24UVZUZG.js → chunk-RWEBCB47.js} +129 -387
- package/dist/chunk-RWEBCB47.js.map +1 -0
- package/dist/{chunk-XWQCNGTQ.js → chunk-YDQHOZNA.js} +173 -79
- package/dist/chunk-YDQHOZNA.js.map +1 -0
- package/dist/{chunk-NECFR5MM.js → chunk-ZNIWI3UC.js} +562 -644
- package/dist/chunk-ZNIWI3UC.js.map +1 -0
- package/dist/components.d.ts +2 -2
- package/dist/components.js +12 -13
- package/dist/contextValidator-3JNZKUTX.js +9 -0
- package/dist/contextValidator-3JNZKUTX.js.map +1 -0
- package/dist/eslint-rules/pace-core-compliance.cjs +106 -0
- package/dist/hooks.d.ts +2 -2
- package/dist/hooks.js +7 -6
- package/dist/hooks.js.map +1 -1
- package/dist/index.d.ts +7 -7
- package/dist/index.js +21 -16
- package/dist/index.js.map +1 -1
- package/dist/providers.d.ts +3 -3
- package/dist/providers.js +4 -3
- package/dist/rbac/index.d.ts +67 -27
- package/dist/rbac/index.js +15 -8
- package/dist/styles/index.js +1 -1
- package/dist/theming/runtime.js +1 -1
- package/dist/types.js +1 -1
- package/dist/{usePublicRouteParams-1oMokgLF.d.ts → usePublicRouteParams-i3qtoBgg.d.ts} +7 -16
- package/dist/utils.js +5 -7
- package/dist/utils.js.map +1 -1
- package/docs/api/README.md +14 -16
- package/docs/api/modules.md +3796 -2513
- package/docs/components/context-selector.md +126 -0
- package/docs/migration/RBAC_SCOPE_MIGRATION.md +385 -0
- package/docs/pace-mint-fix-auto-selection.md +218 -0
- package/docs/pace-mint-rbac-setup.md +391 -0
- package/docs/rbac/secure-client-protection.md +330 -0
- package/package.json +3 -3
- package/scripts/audit/core/checks/compliance.cjs +72 -0
- package/scripts/audit/core/checks/dependencies.cjs +559 -28
- package/scripts/audit/core/checks/documentation.cjs +68 -3
- package/scripts/audit/core/checks/environment.cjs +2 -14
- package/scripts/audit/core/checks/error-handling.cjs +47 -6
- package/src/components/ContextSelector/ContextSelector.tsx +384 -0
- package/src/components/ContextSelector/index.ts +3 -0
- package/src/components/DataTable/components/RowComponent.tsx +19 -19
- package/src/components/DataTable/components/UnifiedTableBody.tsx +2 -2
- package/src/components/DataTable/hooks/useDataTablePermissions.ts +8 -6
- package/src/components/Dialog/Dialog.tsx +29 -1
- package/src/components/FileDisplay/FileDisplay.tsx +42 -10
- package/src/components/Header/Header.test.tsx +43 -73
- package/src/components/Header/Header.tsx +44 -45
- package/src/components/PaceAppLayout/PaceAppLayout.integration.test.tsx +10 -19
- package/src/components/PaceAppLayout/PaceAppLayout.performance.test.tsx +2 -2
- package/src/components/PaceAppLayout/PaceAppLayout.security.test.tsx +5 -5
- package/src/components/PaceAppLayout/PaceAppLayout.test.tsx +9 -9
- package/src/components/PaceAppLayout/PaceAppLayout.tsx +135 -33
- package/src/components/PaceAppLayout/README.md +14 -17
- package/src/components/PaceAppLayout/test-setup.tsx +2 -2
- package/src/components/index.ts +5 -5
- package/src/eslint-rules/pace-core-compliance.cjs +106 -0
- package/src/hooks/__tests__/useAppConfig.unit.test.ts +4 -98
- package/src/hooks/useAppConfig.ts +15 -30
- package/src/hooks/useFileDisplay.ts +77 -50
- package/src/index.ts +4 -5
- package/src/providers/services/AuthServiceProvider.tsx +17 -7
- package/src/providers/services/EventServiceProvider.tsx +33 -5
- package/src/providers/services/UnifiedAuthProvider.tsx +90 -134
- package/src/rbac/__tests__/adapters.comprehensive.test.tsx +1 -1
- package/src/rbac/adapters.tsx +2 -2
- package/src/rbac/api.test.ts +59 -51
- package/src/rbac/api.ts +178 -132
- package/src/rbac/components/PagePermissionGuard.tsx +38 -10
- package/src/rbac/hooks/__tests__/useSecureSupabase.test.ts +32 -21
- package/src/rbac/hooks/permissions/useAccessLevel.ts +1 -1
- package/src/rbac/hooks/permissions/useCan.ts +41 -11
- package/src/rbac/hooks/permissions/useHasAllPermissions.ts +1 -1
- package/src/rbac/hooks/permissions/useHasAnyPermission.ts +1 -1
- package/src/rbac/hooks/permissions/useMultiplePermissions.ts +1 -1
- package/src/rbac/hooks/useCan.test.ts +0 -9
- package/src/rbac/hooks/useRBAC.test.ts +1 -5
- package/src/rbac/hooks/useRBAC.ts +36 -37
- package/src/rbac/hooks/useResolvedScope.test.ts +120 -35
- package/src/rbac/hooks/useResolvedScope.ts +35 -40
- package/src/rbac/hooks/useSecureSupabase.ts +7 -7
- package/src/rbac/index.ts +7 -0
- package/src/rbac/secureClient.test.ts +22 -18
- package/src/rbac/secureClient.ts +103 -16
- package/src/rbac/security.ts +0 -17
- package/src/rbac/types.ts +1 -0
- package/src/rbac/utils/__tests__/contextValidator.test.ts +64 -86
- package/src/rbac/utils/clientSecurity.ts +93 -0
- package/src/rbac/utils/contextValidator.ts +77 -168
- package/src/services/AuthService.ts +39 -7
- package/src/services/EventService.ts +186 -54
- package/src/services/OrganisationService.ts +81 -14
- package/src/services/__tests__/EventService.test.ts +1 -2
- package/src/services/base/BaseService.ts +3 -0
- package/src/utils/dynamic/dynamicUtils.ts +7 -4
- package/dist/chunk-24UVZUZG.js.map +0 -1
- package/dist/chunk-3XC4CPTD.js.map +0 -1
- package/dist/chunk-6J4GEEJR.js.map +0 -1
- package/dist/chunk-7D4SUZUM.js +0 -38
- package/dist/chunk-EHMR7VYL.js.map +0 -1
- package/dist/chunk-NECFR5MM.js.map +0 -1
- package/dist/chunk-SFZUDBL5.js.map +0 -1
- package/dist/chunk-XWQCNGTQ.js.map +0 -1
- package/docs/api/classes/ColumnFactory.md +0 -243
- package/docs/api/classes/InvalidScopeError.md +0 -73
- package/docs/api/classes/Logger.md +0 -178
- package/docs/api/classes/MissingUserContextError.md +0 -66
- package/docs/api/classes/OrganisationContextRequiredError.md +0 -66
- package/docs/api/classes/PermissionDeniedError.md +0 -73
- package/docs/api/classes/RBACAuditManager.md +0 -297
- package/docs/api/classes/RBACCache.md +0 -322
- package/docs/api/classes/RBACEngine.md +0 -171
- package/docs/api/classes/RBACError.md +0 -76
- package/docs/api/classes/RBACNotInitializedError.md +0 -66
- package/docs/api/classes/SecureSupabaseClient.md +0 -163
- package/docs/api/classes/StorageUtils.md +0 -328
- package/docs/api/enums/FileCategory.md +0 -184
- package/docs/api/enums/LogLevel.md +0 -54
- package/docs/api/enums/RBACErrorCode.md +0 -228
- package/docs/api/enums/RPCFunction.md +0 -118
- package/docs/api/interfaces/AddressFieldProps.md +0 -241
- package/docs/api/interfaces/AddressFieldRef.md +0 -94
- package/docs/api/interfaces/AggregateConfig.md +0 -43
- package/docs/api/interfaces/AutocompleteOptions.md +0 -75
- package/docs/api/interfaces/AvatarProps.md +0 -128
- package/docs/api/interfaces/BadgeProps.md +0 -34
- package/docs/api/interfaces/ButtonProps.md +0 -56
- package/docs/api/interfaces/CalendarProps.md +0 -73
- package/docs/api/interfaces/CardProps.md +0 -69
- package/docs/api/interfaces/ColorPalette.md +0 -7
- package/docs/api/interfaces/ColorShade.md +0 -66
- package/docs/api/interfaces/ComplianceResult.md +0 -30
- package/docs/api/interfaces/DataAccessRecord.md +0 -96
- package/docs/api/interfaces/DataRecord.md +0 -11
- package/docs/api/interfaces/DataTableAction.md +0 -252
- package/docs/api/interfaces/DataTableColumn.md +0 -504
- package/docs/api/interfaces/DataTableProps.md +0 -625
- package/docs/api/interfaces/DataTableToolbarButton.md +0 -96
- package/docs/api/interfaces/DatabaseComplianceResult.md +0 -85
- package/docs/api/interfaces/DatabaseIssue.md +0 -41
- package/docs/api/interfaces/EmptyStateConfig.md +0 -61
- package/docs/api/interfaces/EnhancedNavigationMenuProps.md +0 -235
- package/docs/api/interfaces/ErrorBoundaryProps.md +0 -147
- package/docs/api/interfaces/ErrorBoundaryProviderProps.md +0 -36
- package/docs/api/interfaces/ErrorBoundaryState.md +0 -75
- package/docs/api/interfaces/EventAppRoleData.md +0 -71
- package/docs/api/interfaces/ExportColumn.md +0 -90
- package/docs/api/interfaces/ExportOptions.md +0 -126
- package/docs/api/interfaces/FileDisplayProps.md +0 -249
- package/docs/api/interfaces/FileMetadata.md +0 -129
- package/docs/api/interfaces/FileReference.md +0 -118
- package/docs/api/interfaces/FileSizeLimits.md +0 -7
- package/docs/api/interfaces/FileUploadOptions.md +0 -139
- package/docs/api/interfaces/FileUploadProps.md +0 -296
- package/docs/api/interfaces/FooterProps.md +0 -107
- package/docs/api/interfaces/FormFieldProps.md +0 -166
- package/docs/api/interfaces/FormProps.md +0 -113
- package/docs/api/interfaces/GrantEventAppRoleParams.md +0 -122
- package/docs/api/interfaces/InactivityWarningModalProps.md +0 -115
- package/docs/api/interfaces/InputProps.md +0 -56
- package/docs/api/interfaces/LabelProps.md +0 -107
- package/docs/api/interfaces/LoggerConfig.md +0 -62
- package/docs/api/interfaces/LoginFormProps.md +0 -187
- package/docs/api/interfaces/NavigationAccessRecord.md +0 -107
- package/docs/api/interfaces/NavigationContextType.md +0 -164
- package/docs/api/interfaces/NavigationGuardProps.md +0 -139
- package/docs/api/interfaces/NavigationItem.md +0 -120
- package/docs/api/interfaces/NavigationMenuProps.md +0 -221
- package/docs/api/interfaces/NavigationProviderProps.md +0 -117
- package/docs/api/interfaces/Organisation.md +0 -140
- package/docs/api/interfaces/OrganisationContextType.md +0 -388
- package/docs/api/interfaces/OrganisationMembership.md +0 -140
- package/docs/api/interfaces/OrganisationProviderProps.md +0 -76
- package/docs/api/interfaces/OrganisationSecurityError.md +0 -62
- package/docs/api/interfaces/PaceAppLayoutProps.md +0 -409
- package/docs/api/interfaces/PaceLoginPageProps.md +0 -49
- package/docs/api/interfaces/PageAccessRecord.md +0 -85
- package/docs/api/interfaces/PagePermissionContextType.md +0 -140
- package/docs/api/interfaces/PagePermissionGuardProps.md +0 -153
- package/docs/api/interfaces/PagePermissionProviderProps.md +0 -119
- package/docs/api/interfaces/PaletteData.md +0 -41
- package/docs/api/interfaces/ParsedAddress.md +0 -120
- package/docs/api/interfaces/PermissionEnforcerProps.md +0 -153
- package/docs/api/interfaces/ProgressProps.md +0 -42
- package/docs/api/interfaces/ProtectedRouteProps.md +0 -78
- package/docs/api/interfaces/PublicPageFooterProps.md +0 -112
- package/docs/api/interfaces/PublicPageHeaderProps.md +0 -125
- package/docs/api/interfaces/PublicPageLayoutProps.md +0 -185
- package/docs/api/interfaces/QuickFix.md +0 -52
- package/docs/api/interfaces/RBACAccessValidateParams.md +0 -52
- package/docs/api/interfaces/RBACAccessValidateResult.md +0 -41
- package/docs/api/interfaces/RBACAuditLogParams.md +0 -85
- package/docs/api/interfaces/RBACAuditLogResult.md +0 -52
- package/docs/api/interfaces/RBACConfig.md +0 -133
- package/docs/api/interfaces/RBACContext.md +0 -52
- package/docs/api/interfaces/RBACLogger.md +0 -112
- package/docs/api/interfaces/RBACPageAccessCheckParams.md +0 -74
- package/docs/api/interfaces/RBACPerformanceMetrics.md +0 -138
- package/docs/api/interfaces/RBACPermissionCheckParams.md +0 -74
- package/docs/api/interfaces/RBACPermissionCheckResult.md +0 -52
- package/docs/api/interfaces/RBACPermissionsGetParams.md +0 -63
- package/docs/api/interfaces/RBACPermissionsGetResult.md +0 -63
- package/docs/api/interfaces/RBACResult.md +0 -58
- package/docs/api/interfaces/RBACRoleGrantParams.md +0 -63
- package/docs/api/interfaces/RBACRoleGrantResult.md +0 -52
- package/docs/api/interfaces/RBACRoleRevokeParams.md +0 -63
- package/docs/api/interfaces/RBACRoleRevokeResult.md +0 -52
- package/docs/api/interfaces/RBACRoleValidateParams.md +0 -52
- package/docs/api/interfaces/RBACRoleValidateResult.md +0 -63
- package/docs/api/interfaces/RBACRolesListParams.md +0 -52
- package/docs/api/interfaces/RBACRolesListResult.md +0 -74
- package/docs/api/interfaces/RBACSessionTrackParams.md +0 -74
- package/docs/api/interfaces/RBACSessionTrackResult.md +0 -52
- package/docs/api/interfaces/ResourcePermissions.md +0 -155
- package/docs/api/interfaces/RevokeEventAppRoleParams.md +0 -100
- package/docs/api/interfaces/RoleBasedRouterContextType.md +0 -151
- package/docs/api/interfaces/RoleBasedRouterProps.md +0 -156
- package/docs/api/interfaces/RoleManagementResult.md +0 -52
- package/docs/api/interfaces/RouteAccessRecord.md +0 -107
- package/docs/api/interfaces/RouteConfig.md +0 -134
- package/docs/api/interfaces/RuntimeComplianceResult.md +0 -55
- package/docs/api/interfaces/SecureDataContextType.md +0 -168
- package/docs/api/interfaces/SecureDataProviderProps.md +0 -132
- package/docs/api/interfaces/SessionRestorationLoaderProps.md +0 -34
- package/docs/api/interfaces/SetupIssue.md +0 -41
- package/docs/api/interfaces/StorageConfig.md +0 -41
- package/docs/api/interfaces/StorageFileInfo.md +0 -74
- package/docs/api/interfaces/StorageFileMetadata.md +0 -151
- package/docs/api/interfaces/StorageListOptions.md +0 -99
- package/docs/api/interfaces/StorageListResult.md +0 -41
- package/docs/api/interfaces/StorageUploadOptions.md +0 -101
- package/docs/api/interfaces/StorageUploadResult.md +0 -63
- package/docs/api/interfaces/StorageUrlOptions.md +0 -60
- package/docs/api/interfaces/StyleImport.md +0 -19
- package/docs/api/interfaces/SwitchProps.md +0 -34
- package/docs/api/interfaces/TabsContentProps.md +0 -9
- package/docs/api/interfaces/TabsListProps.md +0 -9
- package/docs/api/interfaces/TabsProps.md +0 -9
- package/docs/api/interfaces/TabsTriggerProps.md +0 -50
- package/docs/api/interfaces/TextareaProps.md +0 -53
- package/docs/api/interfaces/ToastActionElement.md +0 -12
- package/docs/api/interfaces/ToastProps.md +0 -9
- package/docs/api/interfaces/UnifiedAuthContextType.md +0 -823
- package/docs/api/interfaces/UnifiedAuthProviderProps.md +0 -173
- package/docs/api/interfaces/UseFormDialogOptions.md +0 -62
- package/docs/api/interfaces/UseFormDialogReturn.md +0 -117
- package/docs/api/interfaces/UseInactivityTrackerOptions.md +0 -138
- package/docs/api/interfaces/UseInactivityTrackerReturn.md +0 -123
- package/docs/api/interfaces/UsePublicEventLogoOptions.md +0 -87
- package/docs/api/interfaces/UsePublicEventLogoReturn.md +0 -84
- package/docs/api/interfaces/UsePublicEventOptions.md +0 -34
- package/docs/api/interfaces/UsePublicEventReturn.md +0 -71
- package/docs/api/interfaces/UsePublicFileDisplayOptions.md +0 -47
- package/docs/api/interfaces/UsePublicFileDisplayReturn.md +0 -123
- package/docs/api/interfaces/UsePublicRouteParamsReturn.md +0 -97
- package/docs/api/interfaces/UseResolvedScopeOptions.md +0 -47
- package/docs/api/interfaces/UseResolvedScopeReturn.md +0 -47
- package/docs/api/interfaces/UseResourcePermissionsOptions.md +0 -34
- package/docs/api/interfaces/UserEventAccess.md +0 -121
- package/docs/api/interfaces/UserMenuProps.md +0 -88
- package/docs/api/interfaces/UserProfile.md +0 -63
- package/src/components/EventSelector/EventSelector.test.tsx +0 -720
- package/src/components/EventSelector/EventSelector.tsx +0 -423
- package/src/components/EventSelector/index.ts +0 -3
- package/src/components/OrganisationSelector/OrganisationSelector.test.tsx +0 -784
- package/src/components/OrganisationSelector/OrganisationSelector.tsx +0 -327
- package/src/components/OrganisationSelector/index.ts +0 -9
- /package/dist/{DataTable-TPTKCX4D.js.map → DataTable-THFPBKTP.js.map} +0 -0
- /package/dist/{UnifiedAuthProvider-CH6Z342H.js.map → UnifiedAuthProvider-KAGUYQ4J.js.map} +0 -0
- /package/dist/{api-MVVQZLJI.js.map → api-IAGWF3ZG.js.map} +0 -0
- /package/dist/{audit-B5P6FFIR.js.map → audit-V53FV5AG.js.map} +0 -0
- /package/dist/{chunk-7D4SUZUM.js.map → chunk-DGUM43GV.js.map} +0 -0
- /package/dist/{chunk-2UOI2FG5.js.map → chunk-HFZBI76P.js.map} +0 -0
- /package/dist/{chunk-F2IMUDXZ.js.map → chunk-M7MPQISP.js.map} +0 -0
|
@@ -1,118 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / FileReference
|
|
2
|
-
|
|
3
|
-
# Interface: FileReference
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [id](FileReference.md#id)
|
|
10
|
-
- [table\_name](FileReference.md#table_name)
|
|
11
|
-
- [record\_id](FileReference.md#record_id)
|
|
12
|
-
- [file\_path](FileReference.md#file_path)
|
|
13
|
-
- [file\_metadata](FileReference.md#file_metadata)
|
|
14
|
-
- [organisation\_id](FileReference.md#organisation_id)
|
|
15
|
-
- [app\_id](FileReference.md#app_id)
|
|
16
|
-
- [is\_public](FileReference.md#is_public)
|
|
17
|
-
- [created\_at](FileReference.md#created_at)
|
|
18
|
-
- [updated\_at](FileReference.md#updated_at)
|
|
19
|
-
|
|
20
|
-
## Properties
|
|
21
|
-
|
|
22
|
-
### id
|
|
23
|
-
|
|
24
|
-
• **id**: `string`
|
|
25
|
-
|
|
26
|
-
#### Defined in
|
|
27
|
-
|
|
28
|
-
[packages/core/src/types/file-reference.ts:7](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L7)
|
|
29
|
-
|
|
30
|
-
___
|
|
31
|
-
|
|
32
|
-
### table\_name
|
|
33
|
-
|
|
34
|
-
• **table\_name**: `string`
|
|
35
|
-
|
|
36
|
-
#### Defined in
|
|
37
|
-
|
|
38
|
-
[packages/core/src/types/file-reference.ts:8](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L8)
|
|
39
|
-
|
|
40
|
-
___
|
|
41
|
-
|
|
42
|
-
### record\_id
|
|
43
|
-
|
|
44
|
-
• **record\_id**: `string`
|
|
45
|
-
|
|
46
|
-
#### Defined in
|
|
47
|
-
|
|
48
|
-
[packages/core/src/types/file-reference.ts:9](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L9)
|
|
49
|
-
|
|
50
|
-
___
|
|
51
|
-
|
|
52
|
-
### file\_path
|
|
53
|
-
|
|
54
|
-
• **file\_path**: `string`
|
|
55
|
-
|
|
56
|
-
#### Defined in
|
|
57
|
-
|
|
58
|
-
[packages/core/src/types/file-reference.ts:10](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L10)
|
|
59
|
-
|
|
60
|
-
___
|
|
61
|
-
|
|
62
|
-
### file\_metadata
|
|
63
|
-
|
|
64
|
-
• **file\_metadata**: [`FileMetadata`](FileMetadata.md)
|
|
65
|
-
|
|
66
|
-
#### Defined in
|
|
67
|
-
|
|
68
|
-
[packages/core/src/types/file-reference.ts:11](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L11)
|
|
69
|
-
|
|
70
|
-
___
|
|
71
|
-
|
|
72
|
-
### organisation\_id
|
|
73
|
-
|
|
74
|
-
• **organisation\_id**: ``null`` \| `string`
|
|
75
|
-
|
|
76
|
-
#### Defined in
|
|
77
|
-
|
|
78
|
-
[packages/core/src/types/file-reference.ts:12](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L12)
|
|
79
|
-
|
|
80
|
-
___
|
|
81
|
-
|
|
82
|
-
### app\_id
|
|
83
|
-
|
|
84
|
-
• **app\_id**: `AppId`
|
|
85
|
-
|
|
86
|
-
#### Defined in
|
|
87
|
-
|
|
88
|
-
[packages/core/src/types/file-reference.ts:13](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L13)
|
|
89
|
-
|
|
90
|
-
___
|
|
91
|
-
|
|
92
|
-
### is\_public
|
|
93
|
-
|
|
94
|
-
• **is\_public**: `boolean`
|
|
95
|
-
|
|
96
|
-
#### Defined in
|
|
97
|
-
|
|
98
|
-
[packages/core/src/types/file-reference.ts:14](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L14)
|
|
99
|
-
|
|
100
|
-
___
|
|
101
|
-
|
|
102
|
-
### created\_at
|
|
103
|
-
|
|
104
|
-
• **created\_at**: `string`
|
|
105
|
-
|
|
106
|
-
#### Defined in
|
|
107
|
-
|
|
108
|
-
[packages/core/src/types/file-reference.ts:15](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L15)
|
|
109
|
-
|
|
110
|
-
___
|
|
111
|
-
|
|
112
|
-
### updated\_at
|
|
113
|
-
|
|
114
|
-
• **updated\_at**: `string`
|
|
115
|
-
|
|
116
|
-
#### Defined in
|
|
117
|
-
|
|
118
|
-
[packages/core/src/types/file-reference.ts:16](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L16)
|
|
@@ -1,139 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / FileUploadOptions
|
|
2
|
-
|
|
3
|
-
# Interface: FileUploadOptions
|
|
4
|
-
|
|
5
|
-
Options for uploading a file with a file reference
|
|
6
|
-
|
|
7
|
-
## Table of contents
|
|
8
|
-
|
|
9
|
-
### Properties
|
|
10
|
-
|
|
11
|
-
- [table\_name](FileUploadOptions.md#table_name)
|
|
12
|
-
- [record\_id](FileUploadOptions.md#record_id)
|
|
13
|
-
- [organisation\_id](FileUploadOptions.md#organisation_id)
|
|
14
|
-
- [app\_id](FileUploadOptions.md#app_id)
|
|
15
|
-
- [category](FileUploadOptions.md#category)
|
|
16
|
-
- [folder](FileUploadOptions.md#folder)
|
|
17
|
-
- [pageContext](FileUploadOptions.md#pagecontext)
|
|
18
|
-
- [event\_id](FileUploadOptions.md#event_id)
|
|
19
|
-
- [is\_public](FileUploadOptions.md#is_public)
|
|
20
|
-
- [custom\_metadata](FileUploadOptions.md#custom_metadata)
|
|
21
|
-
- [userId](FileUploadOptions.md#userid)
|
|
22
|
-
|
|
23
|
-
## Properties
|
|
24
|
-
|
|
25
|
-
### table\_name
|
|
26
|
-
|
|
27
|
-
• **table\_name**: `string`
|
|
28
|
-
|
|
29
|
-
#### Defined in
|
|
30
|
-
|
|
31
|
-
[packages/core/src/types/file-reference.ts:63](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L63)
|
|
32
|
-
|
|
33
|
-
___
|
|
34
|
-
|
|
35
|
-
### record\_id
|
|
36
|
-
|
|
37
|
-
• **record\_id**: `string`
|
|
38
|
-
|
|
39
|
-
#### Defined in
|
|
40
|
-
|
|
41
|
-
[packages/core/src/types/file-reference.ts:64](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L64)
|
|
42
|
-
|
|
43
|
-
___
|
|
44
|
-
|
|
45
|
-
### organisation\_id
|
|
46
|
-
|
|
47
|
-
• **organisation\_id**: ``null`` \| `string`
|
|
48
|
-
|
|
49
|
-
Optional organisation ID. If not provided, the file is user-owned (record_id must match user_id).
|
|
50
|
-
For user-owned files, users can only access their own files.
|
|
51
|
-
|
|
52
|
-
#### Defined in
|
|
53
|
-
|
|
54
|
-
[packages/core/src/types/file-reference.ts:65](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L65)
|
|
55
|
-
|
|
56
|
-
___
|
|
57
|
-
|
|
58
|
-
### app\_id
|
|
59
|
-
|
|
60
|
-
• **app\_id**: `AppId`
|
|
61
|
-
|
|
62
|
-
#### Defined in
|
|
63
|
-
|
|
64
|
-
[packages/core/src/types/file-reference.ts:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L66)
|
|
65
|
-
|
|
66
|
-
___
|
|
67
|
-
|
|
68
|
-
### category
|
|
69
|
-
|
|
70
|
-
• **category**: [`FileCategory`](../enums/FileCategory.md)
|
|
71
|
-
|
|
72
|
-
#### Defined in
|
|
73
|
-
|
|
74
|
-
[packages/core/src/types/file-reference.ts:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L67)
|
|
75
|
-
|
|
76
|
-
___
|
|
77
|
-
|
|
78
|
-
### folder
|
|
79
|
-
|
|
80
|
-
• **folder**: `string`
|
|
81
|
-
|
|
82
|
-
#### Defined in
|
|
83
|
-
|
|
84
|
-
[packages/core/src/types/file-reference.ts:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L68)
|
|
85
|
-
|
|
86
|
-
___
|
|
87
|
-
|
|
88
|
-
### pageContext
|
|
89
|
-
|
|
90
|
-
• **pageContext**: `string`
|
|
91
|
-
|
|
92
|
-
The page context where the file upload occurs (e.g., 'configuration', 'forms', 'applications')
|
|
93
|
-
Used for context-aware permission checks. Required to check appropriate page-level permissions.
|
|
94
|
-
|
|
95
|
-
#### Defined in
|
|
96
|
-
|
|
97
|
-
[packages/core/src/types/file-reference.ts:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L69)
|
|
98
|
-
|
|
99
|
-
___
|
|
100
|
-
|
|
101
|
-
### event\_id
|
|
102
|
-
|
|
103
|
-
• `Optional` **event\_id**: `string`
|
|
104
|
-
|
|
105
|
-
Optional event ID for event-scoped permission checks. Required for event-based apps.
|
|
106
|
-
|
|
107
|
-
#### Defined in
|
|
108
|
-
|
|
109
|
-
[packages/core/src/types/file-reference.ts:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L70)
|
|
110
|
-
|
|
111
|
-
___
|
|
112
|
-
|
|
113
|
-
### is\_public
|
|
114
|
-
|
|
115
|
-
• `Optional` **is\_public**: `boolean`
|
|
116
|
-
|
|
117
|
-
#### Defined in
|
|
118
|
-
|
|
119
|
-
[packages/core/src/types/file-reference.ts:71](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L71)
|
|
120
|
-
|
|
121
|
-
___
|
|
122
|
-
|
|
123
|
-
### custom\_metadata
|
|
124
|
-
|
|
125
|
-
• `Optional` **custom\_metadata**: `Record`\<`string`, `unknown`\>
|
|
126
|
-
|
|
127
|
-
#### Defined in
|
|
128
|
-
|
|
129
|
-
[packages/core/src/types/file-reference.ts:72](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L72)
|
|
130
|
-
|
|
131
|
-
___
|
|
132
|
-
|
|
133
|
-
### userId
|
|
134
|
-
|
|
135
|
-
• `Optional` **userId**: `string`
|
|
136
|
-
|
|
137
|
-
#### Defined in
|
|
138
|
-
|
|
139
|
-
[packages/core/src/types/file-reference.ts:73](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L73)
|
|
@@ -1,296 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / FileUploadProps
|
|
2
|
-
|
|
3
|
-
# Interface: FileUploadProps
|
|
4
|
-
|
|
5
|
-
Props for the FileUpload component.
|
|
6
|
-
Configures file upload behavior including storage location, validation, and callbacks.
|
|
7
|
-
|
|
8
|
-
## Table of contents
|
|
9
|
-
|
|
10
|
-
### Properties
|
|
11
|
-
|
|
12
|
-
- [supabase](FileUploadProps.md#supabase)
|
|
13
|
-
- [table\_name](FileUploadProps.md#table_name)
|
|
14
|
-
- [record\_id](FileUploadProps.md#record_id)
|
|
15
|
-
- [organisation\_id](FileUploadProps.md#organisation_id)
|
|
16
|
-
- [userId](FileUploadProps.md#userid)
|
|
17
|
-
- [app\_id](FileUploadProps.md#app_id)
|
|
18
|
-
- [category](FileUploadProps.md#category)
|
|
19
|
-
- [folder](FileUploadProps.md#folder)
|
|
20
|
-
- [pageContext](FileUploadProps.md#pagecontext)
|
|
21
|
-
- [event\_id](FileUploadProps.md#event_id)
|
|
22
|
-
- [accept](FileUploadProps.md#accept)
|
|
23
|
-
- [maxSize](FileUploadProps.md#maxsize)
|
|
24
|
-
- [multiple](FileUploadProps.md#multiple)
|
|
25
|
-
- [disabled](FileUploadProps.md#disabled)
|
|
26
|
-
- [isPublic](FileUploadProps.md#ispublic)
|
|
27
|
-
- [className](FileUploadProps.md#classname)
|
|
28
|
-
- [showPreview](FileUploadProps.md#showpreview)
|
|
29
|
-
- [showProgress](FileUploadProps.md#showprogress)
|
|
30
|
-
- [onUploadSuccess](FileUploadProps.md#onuploadsuccess)
|
|
31
|
-
- [onUploadError](FileUploadProps.md#onuploaderror)
|
|
32
|
-
- [onProgress](FileUploadProps.md#onprogress)
|
|
33
|
-
- [children](FileUploadProps.md#children)
|
|
34
|
-
|
|
35
|
-
## Properties
|
|
36
|
-
|
|
37
|
-
### supabase
|
|
38
|
-
|
|
39
|
-
• **supabase**: `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\>
|
|
40
|
-
|
|
41
|
-
#### Defined in
|
|
42
|
-
|
|
43
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:23](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L23)
|
|
44
|
-
|
|
45
|
-
___
|
|
46
|
-
|
|
47
|
-
### table\_name
|
|
48
|
-
|
|
49
|
-
• **table\_name**: `string`
|
|
50
|
-
|
|
51
|
-
#### Defined in
|
|
52
|
-
|
|
53
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:24](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L24)
|
|
54
|
-
|
|
55
|
-
___
|
|
56
|
-
|
|
57
|
-
### record\_id
|
|
58
|
-
|
|
59
|
-
• **record\_id**: `string`
|
|
60
|
-
|
|
61
|
-
#### Defined in
|
|
62
|
-
|
|
63
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:25](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L25)
|
|
64
|
-
|
|
65
|
-
___
|
|
66
|
-
|
|
67
|
-
### organisation\_id
|
|
68
|
-
|
|
69
|
-
• `Optional` **organisation\_id**: ``null`` \| `string`
|
|
70
|
-
|
|
71
|
-
#### Defined in
|
|
72
|
-
|
|
73
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:26](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L26)
|
|
74
|
-
|
|
75
|
-
___
|
|
76
|
-
|
|
77
|
-
### userId
|
|
78
|
-
|
|
79
|
-
• `Optional` **userId**: `string`
|
|
80
|
-
|
|
81
|
-
#### Defined in
|
|
82
|
-
|
|
83
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:27](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L27)
|
|
84
|
-
|
|
85
|
-
___
|
|
86
|
-
|
|
87
|
-
### app\_id
|
|
88
|
-
|
|
89
|
-
• `Optional` **app\_id**: `string`
|
|
90
|
-
|
|
91
|
-
#### Defined in
|
|
92
|
-
|
|
93
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:28](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L28)
|
|
94
|
-
|
|
95
|
-
___
|
|
96
|
-
|
|
97
|
-
### category
|
|
98
|
-
|
|
99
|
-
• **category**: [`FileCategory`](../enums/FileCategory.md)
|
|
100
|
-
|
|
101
|
-
#### Defined in
|
|
102
|
-
|
|
103
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:29](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L29)
|
|
104
|
-
|
|
105
|
-
___
|
|
106
|
-
|
|
107
|
-
### folder
|
|
108
|
-
|
|
109
|
-
• **folder**: `string`
|
|
110
|
-
|
|
111
|
-
#### Defined in
|
|
112
|
-
|
|
113
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L30)
|
|
114
|
-
|
|
115
|
-
___
|
|
116
|
-
|
|
117
|
-
### pageContext
|
|
118
|
-
|
|
119
|
-
• **pageContext**: `string`
|
|
120
|
-
|
|
121
|
-
#### Defined in
|
|
122
|
-
|
|
123
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:31](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L31)
|
|
124
|
-
|
|
125
|
-
___
|
|
126
|
-
|
|
127
|
-
### event\_id
|
|
128
|
-
|
|
129
|
-
• `Optional` **event\_id**: `string`
|
|
130
|
-
|
|
131
|
-
#### Defined in
|
|
132
|
-
|
|
133
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:32](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L32)
|
|
134
|
-
|
|
135
|
-
___
|
|
136
|
-
|
|
137
|
-
### accept
|
|
138
|
-
|
|
139
|
-
• `Optional` **accept**: `string`
|
|
140
|
-
|
|
141
|
-
#### Defined in
|
|
142
|
-
|
|
143
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:33](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L33)
|
|
144
|
-
|
|
145
|
-
___
|
|
146
|
-
|
|
147
|
-
### maxSize
|
|
148
|
-
|
|
149
|
-
• `Optional` **maxSize**: `number`
|
|
150
|
-
|
|
151
|
-
#### Defined in
|
|
152
|
-
|
|
153
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:34](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L34)
|
|
154
|
-
|
|
155
|
-
___
|
|
156
|
-
|
|
157
|
-
### multiple
|
|
158
|
-
|
|
159
|
-
• `Optional` **multiple**: `boolean`
|
|
160
|
-
|
|
161
|
-
#### Defined in
|
|
162
|
-
|
|
163
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:35](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L35)
|
|
164
|
-
|
|
165
|
-
___
|
|
166
|
-
|
|
167
|
-
### disabled
|
|
168
|
-
|
|
169
|
-
• `Optional` **disabled**: `boolean`
|
|
170
|
-
|
|
171
|
-
#### Defined in
|
|
172
|
-
|
|
173
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:36](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L36)
|
|
174
|
-
|
|
175
|
-
___
|
|
176
|
-
|
|
177
|
-
### isPublic
|
|
178
|
-
|
|
179
|
-
• `Optional` **isPublic**: `boolean`
|
|
180
|
-
|
|
181
|
-
#### Defined in
|
|
182
|
-
|
|
183
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:37](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L37)
|
|
184
|
-
|
|
185
|
-
___
|
|
186
|
-
|
|
187
|
-
### className
|
|
188
|
-
|
|
189
|
-
• `Optional` **className**: `string`
|
|
190
|
-
|
|
191
|
-
#### Defined in
|
|
192
|
-
|
|
193
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:38](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L38)
|
|
194
|
-
|
|
195
|
-
___
|
|
196
|
-
|
|
197
|
-
### showPreview
|
|
198
|
-
|
|
199
|
-
• `Optional` **showPreview**: `boolean`
|
|
200
|
-
|
|
201
|
-
#### Defined in
|
|
202
|
-
|
|
203
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:39](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L39)
|
|
204
|
-
|
|
205
|
-
___
|
|
206
|
-
|
|
207
|
-
### showProgress
|
|
208
|
-
|
|
209
|
-
• `Optional` **showProgress**: `boolean`
|
|
210
|
-
|
|
211
|
-
#### Defined in
|
|
212
|
-
|
|
213
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:40](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L40)
|
|
214
|
-
|
|
215
|
-
___
|
|
216
|
-
|
|
217
|
-
### onUploadSuccess
|
|
218
|
-
|
|
219
|
-
• `Optional` **onUploadSuccess**: (`result`: `FileUploadResult`) => `void`
|
|
220
|
-
|
|
221
|
-
#### Type declaration
|
|
222
|
-
|
|
223
|
-
▸ (`result`): `void`
|
|
224
|
-
|
|
225
|
-
##### Parameters
|
|
226
|
-
|
|
227
|
-
| Name | Type |
|
|
228
|
-
| :------ | :------ |
|
|
229
|
-
| `result` | `FileUploadResult` |
|
|
230
|
-
|
|
231
|
-
##### Returns
|
|
232
|
-
|
|
233
|
-
`void`
|
|
234
|
-
|
|
235
|
-
#### Defined in
|
|
236
|
-
|
|
237
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:41](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L41)
|
|
238
|
-
|
|
239
|
-
___
|
|
240
|
-
|
|
241
|
-
### onUploadError
|
|
242
|
-
|
|
243
|
-
• `Optional` **onUploadError**: (`error`: `string`, `file?`: `File`) => `void`
|
|
244
|
-
|
|
245
|
-
#### Type declaration
|
|
246
|
-
|
|
247
|
-
▸ (`error`, `file?`): `void`
|
|
248
|
-
|
|
249
|
-
##### Parameters
|
|
250
|
-
|
|
251
|
-
| Name | Type |
|
|
252
|
-
| :------ | :------ |
|
|
253
|
-
| `error` | `string` |
|
|
254
|
-
| `file?` | `File` |
|
|
255
|
-
|
|
256
|
-
##### Returns
|
|
257
|
-
|
|
258
|
-
`void`
|
|
259
|
-
|
|
260
|
-
#### Defined in
|
|
261
|
-
|
|
262
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:42](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L42)
|
|
263
|
-
|
|
264
|
-
___
|
|
265
|
-
|
|
266
|
-
### onProgress
|
|
267
|
-
|
|
268
|
-
• `Optional` **onProgress**: (`progress`: `UploadProgress`) => `void`
|
|
269
|
-
|
|
270
|
-
#### Type declaration
|
|
271
|
-
|
|
272
|
-
▸ (`progress`): `void`
|
|
273
|
-
|
|
274
|
-
##### Parameters
|
|
275
|
-
|
|
276
|
-
| Name | Type |
|
|
277
|
-
| :------ | :------ |
|
|
278
|
-
| `progress` | `UploadProgress` |
|
|
279
|
-
|
|
280
|
-
##### Returns
|
|
281
|
-
|
|
282
|
-
`void`
|
|
283
|
-
|
|
284
|
-
#### Defined in
|
|
285
|
-
|
|
286
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:43](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L43)
|
|
287
|
-
|
|
288
|
-
___
|
|
289
|
-
|
|
290
|
-
### children
|
|
291
|
-
|
|
292
|
-
• `Optional` **children**: `ReactNode`
|
|
293
|
-
|
|
294
|
-
#### Defined in
|
|
295
|
-
|
|
296
|
-
[packages/core/src/components/FileUpload/FileUpload.tsx:44](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L44)
|
|
@@ -1,107 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / FooterProps
|
|
2
|
-
|
|
3
|
-
# Interface: FooterProps
|
|
4
|
-
|
|
5
|
-
Props for the Footer component.
|
|
6
|
-
|
|
7
|
-
## Table of contents
|
|
8
|
-
|
|
9
|
-
### Properties
|
|
10
|
-
|
|
11
|
-
- [companyName](FooterProps.md#companyname)
|
|
12
|
-
- [year](FooterProps.md#year)
|
|
13
|
-
- [links](FooterProps.md#links)
|
|
14
|
-
- [className](FooterProps.md#classname)
|
|
15
|
-
- [logo](FooterProps.md#logo)
|
|
16
|
-
- [copyright](FooterProps.md#copyright)
|
|
17
|
-
- [children](FooterProps.md#children)
|
|
18
|
-
|
|
19
|
-
## Properties
|
|
20
|
-
|
|
21
|
-
### companyName
|
|
22
|
-
|
|
23
|
-
• `Optional` **companyName**: `string`
|
|
24
|
-
|
|
25
|
-
Company or organization name
|
|
26
|
-
|
|
27
|
-
#### Defined in
|
|
28
|
-
|
|
29
|
-
[packages/core/src/components/Footer/Footer.tsx:97](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L97)
|
|
30
|
-
|
|
31
|
-
___
|
|
32
|
-
|
|
33
|
-
### year
|
|
34
|
-
|
|
35
|
-
• `Optional` **year**: `number`
|
|
36
|
-
|
|
37
|
-
Current year or custom year for copyright
|
|
38
|
-
|
|
39
|
-
**`Default`**
|
|
40
|
-
|
|
41
|
-
```ts
|
|
42
|
-
current year
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
#### Defined in
|
|
46
|
-
|
|
47
|
-
[packages/core/src/components/Footer/Footer.tsx:103](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L103)
|
|
48
|
-
|
|
49
|
-
___
|
|
50
|
-
|
|
51
|
-
### links
|
|
52
|
-
|
|
53
|
-
• `Optional` **links**: \{ `label`: `string` ; `href`: `string` }[]
|
|
54
|
-
|
|
55
|
-
Optional array of navigation links to display
|
|
56
|
-
|
|
57
|
-
#### Defined in
|
|
58
|
-
|
|
59
|
-
[packages/core/src/components/Footer/Footer.tsx:108](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L108)
|
|
60
|
-
|
|
61
|
-
___
|
|
62
|
-
|
|
63
|
-
### className
|
|
64
|
-
|
|
65
|
-
• `Optional` **className**: `string`
|
|
66
|
-
|
|
67
|
-
Optional CSS class name
|
|
68
|
-
|
|
69
|
-
#### Defined in
|
|
70
|
-
|
|
71
|
-
[packages/core/src/components/Footer/Footer.tsx:116](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L116)
|
|
72
|
-
|
|
73
|
-
___
|
|
74
|
-
|
|
75
|
-
### logo
|
|
76
|
-
|
|
77
|
-
• `Optional` **logo**: `string`
|
|
78
|
-
|
|
79
|
-
Logo image URL (from UI version)
|
|
80
|
-
|
|
81
|
-
#### Defined in
|
|
82
|
-
|
|
83
|
-
[packages/core/src/components/Footer/Footer.tsx:121](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L121)
|
|
84
|
-
|
|
85
|
-
___
|
|
86
|
-
|
|
87
|
-
### copyright
|
|
88
|
-
|
|
89
|
-
• `Optional` **copyright**: `string`
|
|
90
|
-
|
|
91
|
-
Copyright text (from UI version)
|
|
92
|
-
|
|
93
|
-
#### Defined in
|
|
94
|
-
|
|
95
|
-
[packages/core/src/components/Footer/Footer.tsx:126](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L126)
|
|
96
|
-
|
|
97
|
-
___
|
|
98
|
-
|
|
99
|
-
### children
|
|
100
|
-
|
|
101
|
-
• `Optional` **children**: `ReactNode`
|
|
102
|
-
|
|
103
|
-
Footer content - children to render inside footer
|
|
104
|
-
|
|
105
|
-
#### Defined in
|
|
106
|
-
|
|
107
|
-
[packages/core/src/components/Footer/Footer.tsx:131](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L131)
|