Ngx Stripe is a comprehensive library designed for seamless integration of [`Stripe Elements`](https://stripe.com/docs/stripe-js) and payment processing capabilities into Angular applications. Leveraging the powerful features of [`StripeJS`](https://stripe.com/docs/js), Ngx Stripe simplifies building robust, secure, and scalable payment solutions.

Use Elements with any Stripe product to collect online payments. For the right integration path for your business, explore the [`Stripe Docs`](https://stripe.com/docs/stripe-js).

Learn how to use `ngx-stripe` on the **new** [docs site](https://ngx-stripe.dev/docs) 🤓

## Notice (November 27, 2024)

We are pleased to announce that as of version `19.0.0`, this library now supports Stripe V5. This release introduces a **major version upgrade**, with one notable breaking change:

- `StripeCustomCheckout` has been renamed to `StripeCheckout`.
- `StripeCustomCheckoutOptions` has been renamed to `StripeCheckoutOptions`.
- The method `initCustomCheckout` is now `initCheckout`.

To maintain alignment with Angular's major versioning, which evolves more frequently than Stripe, we have opted to deviate from the traditional semantic versioning (semver) standard. We believe this approach will deliver a smoother experience over time.

We apologize for any inconvenience this change may cause and appreciate your understanding.

## Features

- **Angular Components for Stripe Elements**: Ngx Stripe provides a set of Angular components, each corresponding to a specific Stripe Web Element. These components are designed to simplify the integration of Stripe's UI elements, ensuring a smooth and consistent user experience.
- **Seamless Integration with StripeJS**: Aligning closely with StripeJS, Ngx Stripe ensures that you have access to the latest features and updates from Stripe, directly within your Angular application.
- **Lazy Loading of StripeJS**: Enhance your application's performance by lazy loading the StripeJS JavaScript. This feature ensures that the StripeJS library is loaded only when needed, optimizing loading times and improving the overall user experience.
- **Customizable and Flexible**: Customize the look and feel of your payment forms to match your application's design. Ngx Stripe components are highly flexible, allowing for extensive customization and styling.
- **Strongly Typed for Angular Development**: Benefit from TypeScript in your payment integration. Ngx Stripe is strongly typed, making

## Installation

**Active Versions**

To install the last active version:

```bash
$ npm install ngx-stripe @stripe/stripe-js
```

To install a specific version for an older Angular major, use the LTS npm tags or check the table below to pick the right version. For example, for v8:

```bash
$ npm install ngx-stripe@v14-lts @stripe/stripe-js
```

Choose the version corresponding to your Angular version:

| Angular | ngx-stripe |
| ------- | ----------------- |
| 19 | 19.x+ |
| 18 | 18.x+ |
| 17 | 17.x+ |
| 16 | 16.x+ |
| 15 | 15.x+ |
| 14 | 14.x+ |
| 13 | 13.x+ |
| 12 | 12.x+ |
| 11 | 11.x+ |
| 10 | 10.x+ |
| 9 | v9-lts / 9.4.0 |
| 8 | v8-lts / 8.2.0 |

---

## Using the library

Most of the documentation has been moved to the new [docs site](https://ngx-stripe.dev/docs). Only a very basic example is left here:

We start by adding the providers to our app:

```ts
import { provideNgxStripe } from 'ngx-stripe';

bootstrapApplication(AppComponent, {
providers: [
// ... rest of your providers
provideNgxStripe()
]
});
```

Or if you're still using modules:

Import the `NgxStripeModule` into your application:

```typescript
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';

// Import the library
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';

// Import the library
import { NgxStripeModule } from 'ngx-stripe';

@NgModule({
declarations: [AppComponent],
imports: [
BrowserModule,
// ... rest of your imports
NgxStripeModule.forRoot(),
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule {}

```

## Payment Element Component

Once the module has been imported, you can collect credit card details using the ngx-stripe-card component.

Then you can use the Stripe Service, which is basically an Observable wrapper around the stripejs object, to use that information. In this example, we use it to create a token, but it can be used to confirm a Payment Intent, Setup Intent, etc...

Please check the [docs site](https://ngx-stripe.dev/docs) to see a complete set of Stripe Element Components available and the full API of the Stripe Service.

```xml

```typescript
import { Component, inject, signal, ViewChild } from '@angular/core';
import { UntypedFormBuilder, Validators } from '@angular/forms';

import { MatInputModule } from '@angular/material/input';

import {
injectStripe,
StripePaymentElementComponent
} from 'ngx-stripe';
import {
StripeElementsOptions,
StripePaymentElementOptions
} from '@stripe/stripe-js';

@Component({
selector: 'ngstr-checkout-form',
templateUrl: './payment-element.component.html',
standalone: true,
imports: [
ReactiveFormsModule,
MatInputModule,
StripePaymentElementComponent
]
})
export class CheckoutFormComponent {
@ViewChild(StripePaymentElementComponent)
paymentElement!: StripePaymentElementComponent;

private readonly fb = inject(UntypedFormBuilder);