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

[SID-1548] Configuration extension: share the configuration interface with React SDK #18

Merged
merged 7 commits into from
Feb 12, 2024

Conversation

ikovic
Copy link
Contributor

@ikovic ikovic commented Feb 12, 2024

Login theme will now accept an additional configuration parameter - formConfiguration. This optional parameter accepts an object of the same shape as the props of the ConfigurationProvider.

This will add extra flexibility and remove friction between the underlying React SDK and the docusaurus theme.

Testing

I published a beta version @slashid/[email protected] to facilitate testing, so the most relevant test steps would be these:

  • create a new Docusaurus website using docusaurus v2 (v3 is not supported yet)
  • follow the Readme to set the theme up (but please make sure to install @slashid/[email protected])
  • check the docs and play with the formConfiguration option to see if various combinations still work

Legacy configuration API has the extra fields to set up OIDC but they are no longer documented:

slashID.oidcClientID
slashID.oidcProvider

We still support them so that the theme does not break someones website if they update to the next minor version. If you pass the legacy options, the new formConfiguration option will be ignored.

@ikovic ikovic self-assigned this Feb 12, 2024
Copy link

cloudflare-workers-and-pages bot commented Feb 12, 2024

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7f66425
Status: ✅  Deploy successful!
Preview URL: https://7cbc19c3.docusaurus-slashid-login.pages.dev
Branch Preview URL: https://sid-1548-configuration-exten.docusaurus-slashid-login.pages.dev

View logs

@ikovic ikovic merged commit 83d9e77 into main Feb 12, 2024
2 checks passed
@ikovic ikovic deleted the sid-1548-configuration-extension branch February 12, 2024 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants