Skip to content

Commit c1bab4d

Browse files
committed
update README
1 parent 30044e5 commit c1bab4d

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

openam-ui/openam-ui-js-sdk/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,11 @@ To customize the application behaviour, customise the following settings:
7070
export interface Config {
7171
openamServer: string; //OpenAM server host, for example http://openam.example.org:8080
7272
openamContextPath: string; //OpenAM context path, for example /openam
73-
loginForm: LoginForm; //LoginForm interface implementation
74-
userForm: UserForm; //UserForm interface implementation
75-
errorForm: ErrorForm; //ErrorForm interface implementation
76-
callbackElement: CallbackElement; //CallbackElement interface implementation
77-
actionElements: ActionElements; //ActionElements interface implementation
73+
LoginForm: LoginForm; //LoginForm interface implementation
74+
UserForm: UserForm; //UserForm interface implementation
75+
ErrorForm: ErrorForm; //ErrorForm interface implementation
76+
CallbackElement: CallbackElement; //CallbackElement interface implementation
77+
ActionElements: ActionElements; //ActionElements interface implementation
7878
redirectOnSuccessfulLogin: boolean; //redirects user on successful login to the target URL, otherwise shows a profile.
7979
getOpenAmUrl: () => string; //returns a full OpenAM URL, for example http://openam.example.org:8080/openam
8080
}
@@ -122,8 +122,9 @@ export type CallbackElement = React.FC<{
122122

123123
// renders a user profile form
124124
export type UserForm = React.FC<{
125-
userAuthData: UserAuthData;
126-
userService: UserService;
125+
userData: UserData,
126+
setUserData: (userData: UserData) => void
127+
saveHandler: () => void
127128
}>
128129

129130
// renders an authentication error form
@@ -132,7 +133,7 @@ export type ErrorForm = React.FC<{
132133
resetError: () => void
133134
}>
134135

135-
// renders submit buttons, if there are no ConfirmationCallback in the callbacks array, renders the default button
136+
// renders submit buttons; if there are no ConfirmationCallback in the callbacks array, renders the default button
136137
export type ActionElements = React.FC<{callbacks: Callback[]}>
137138
```
138139

0 commit comments

Comments
 (0)