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.

Sign up for GitHub

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

Jump to bottom

Add defaultValues to StripePaymentElementOptions interface #332

Merged
merged 3 commits into from
Jun 16, 2022
Merged

Add defaultValues to StripePaymentElementOptions interface #332

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce4096c
Add `defaultValues` to `StripePaymentElementOptions`
starsirius Jun 15, 2022
13edc02
Run prettier
starsirius Jun 16, 2022
2ad16db
Use :snake: case for postal code
starsirius Jun 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions tests/types/src/valid.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,21 @@ const afterpayClearpayMessageElement = elements.create(
);

const paymentElement: StripePaymentElement = elements.create('payment', {
defaultValues: {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure how exhaustive I should be for the tests. Please let me know if anything can be added!

billingDetails: {
name: 'Jane Doe',
email: 'jane.doe@example.com',
phone: '8004444444',
address: {
line1: '354 Oyster Point Blvd',
line2: '',
city: 'South San Francisco',
state: 'CA',
country: 'US',
postalCode: '94080'
Copy link
Contributor

Choose a reason for hiding this comment

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

And then same here :)

}
}
},
fields: {
billingDetails: {
email: 'never',
Expand Down
23 changes: 23 additions & 0 deletions types/stripe-js/elements/payment.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,24 @@ export type StripePaymentElement = StripeElementBase & {
collapse(): StripePaymentElement;
};

export interface DefaultValuesOption {
billingDetails?:
{
name?: string;
email?: string;
phone?: string;
address?:
{
country?: string;
postalCode?: string;
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be postal_code instead of postalCode (doc)!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jackieosborn-stripe Thank you for the quick review and nice catch!

And just to surface it, it seems inconsistent, for example with the postalCode in the fields option.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated it in 2ad16db.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for bringing it up - we're aware of the inconsistencies 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Awesome! Thank you! Looking forward to getting this released! 🎉

state?: string;
city?: string;
line1?: string;
line2?: string;
};
};
}

export type FieldOption = 'auto' | 'never';

export interface FieldsOption {
Expand Down Expand Up @@ -152,6 +170,11 @@ export interface WalletsOption {
}

export interface StripePaymentElementOptions {
/**
* Provide initial customer information that will be displayed in the Payment Element.
*/
defaultValues?: DefaultValuesOption;

/**
* Override the business name displayed in the Payment Element.
* By default the PaymentElement will use your Stripe account or business name.
Expand Down