Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #125

Merged
merged 1 commit into from
May 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ Install from the command line
npm run setup
```

To setup musicfestival:
- https://github.com/episerver/content-headless-form-js-sdk/tree/develop/samples/musicfestival-backend-dotnet
- https://github.com/episerver/content-headless-form-js-sdk/tree/develop/samples/musicfestival-frontend-react

3. Build all projects

```sh
Expand Down Expand Up @@ -87,4 +91,4 @@ Create a form with some elements in MainContentArea of Start page.

```sh
http://localhost:3000/
```
```
1 change: 1 addition & 0 deletions samples/musicfestival-frontend-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ This project uses:
- `...`
- `models/` contains models retrieving messages from CMS
- `pages/` contains all pages of the site
- `BuyTicketPage.tsx` render form using data retrieved from Content Graph
- `authService.js` contains OIDC config
- `generated.ts` is generated file on folder `graphql/`
- `...`
Expand Down
20 changes: 20 additions & 0 deletions src/@episerver/forms-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,26 @@ This is the main component that will be used to render the form from the metadat
* currentPageUrl - The public url of current page
* optiGraphUrl - The endpoint url of Optimizely Graph with your singlekey

## FormContainerBlock
### Description
This is the main component that will be used to render the form from data received from the Headless Form API
### Usage
```js
<FormContainerBlock
form={formData}
identityInfo={identityInfo}
baseUrl={"/"}
history={history}
currentPageUrl={"http://yourdomain/en/"}
/>
```
### Propperties
* form - The form data to render form
* identityInfo - Access token for form submit
* baseUrl - The base url of Headless Form API
* history - The instance of useHistory() received from react-router-dom
* currentPageUrl - The public url of current page

## FormLogin
### Description
This is a component that will be used to render a login form, it helps to login to Headless Form API
Expand Down
Loading