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

Features/getcredential update #1540

Merged
merged 5 commits into from
Sep 25, 2023
Merged

Features/getcredential update #1540

merged 5 commits into from
Sep 25, 2023

Conversation

BaskarMitrah
Copy link
Collaborator

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link
Collaborator

@louisachu louisachu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may want to explain className to be used in any css files to customize the component. We probably want to remove the className in the GetCredn

README.md Outdated
@@ -2458,6 +2458,179 @@ You can query multiple elements, for example you can add the section with the im
```
<Debugging query="product=Photoshop&image=test" />
```
# Get Credential

The Get Credential component allows you to easily generate credentials and access code samples directly from the developer website. Child component should only work if it's inside the parent GetCredential component
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may want to add information that this is using the developer console apis to generate the credentials?

README.md Outdated

Use `service`(optional) prop to define the Adobe Product & Service.The preset is `CCEmbedCompanionAPI`.

Use `className` to customize the component **at your own risk.**.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I notice that in our example of the GetCredentialExternal.js actually have a className but was never really used in the css file. We may want to remove that. Also, include an explaination that they can just use css with className to customize the components to their desired style.

Use `buttonText`(required) to specify the sign-in button label

`GetCredential.Form` is a flexible for designing the credential form, ensuring a seamless and personalized user experience.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a header for each one of the different headings? Just like the GetCredential.SignIn? It's easier to read if we have different headings.

```

Create the new JS component in the component folder and import the component in the markdown file wherever you want to add credentail

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explain the use of a .css file here as well.


```


Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think some screen shots will be nice to be added.

@louisachu louisachu merged commit 966f69b into main Sep 25, 2023
@louisachu louisachu deleted the features/getcredential_update branch September 25, 2023 23:49
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.

2 participants