> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Configuración del SDK web de Angular
> Integre notificaciones push web de OneSignal en su aplicación Angular usando el paquete onesignal-ngx. Aprenda cómo instalar, configurar y solucionar problemas de service workers para entregar notificaciones push sin problemas.
export const SdkReleasesIframe = ({sdkFilter = undefined, viewMode = undefined, height, ...frameProps}) => {
const baseUrl = 'https://onesignal.github.io/sdk-releases';
const buildUrl = (theme, sdkFilter, viewMode) => {
const url = new URL(baseUrl);
const params = new URLSearchParams();
if (theme) {
params.set('theme', theme);
}
if (sdkFilter) {
params.set('sdk', sdkFilter);
}
if (viewMode) {
params.set('viewMode', viewMode);
}
if (params.toString()) {
url.search = params.toString();
}
return url.toString();
};
const detectTheme = () => {
if (document.documentElement.classList.contains('dark')) {
return 'dark';
}
return 'light';
};
const [theme, setTheme] = useState('light');
const [iframeSrc, setIframeSrc] = useState(() => {
const initialTheme = detectTheme();
return buildUrl(initialTheme, sdkFilter, viewMode);
});
useEffect(() => {
const currentTheme = detectTheme();
setTheme(currentTheme);
setIframeSrc(buildUrl(currentTheme, sdkFilter, viewMode));
const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)');
const handleThemeChange = () => {
const newTheme = detectTheme();
setTheme(newTheme);
setIframeSrc(buildUrl(newTheme, sdkFilter, viewMode));
};
if (mediaQuery.addEventListener) {
mediaQuery.addEventListener('change', handleThemeChange);
} else {
mediaQuery.addListener(handleThemeChange);
}
window.addEventListener('storage', handleThemeChange);
const observer = new MutationObserver(handleThemeChange);
observer.observe(document.documentElement, {
attributes: true,
attributeFilter: ['class', 'data-theme']
});
return () => {
if (mediaQuery.removeEventListener) {
mediaQuery.removeEventListener('change', handleThemeChange);
} else {
mediaQuery.removeListener(handleThemeChange);
}
window.removeEventListener('storage', handleThemeChange);
observer.disconnect();
};
}, [sdkFilter, viewMode]);
const getIframeHeight = () => {
if (viewMode === 'table') {
return '450';
}
if (viewMode === 'mini') {
return '170';
}
return '800';
};
const iframeHeight = height || getIframeHeight();
return
;
};
## Descripción general
Esta guía explica cómo configurar notificaciones push en su aplicación Angular usando el paquete `onesignal-ngx`, cubriendo todo desde la instalación hasta la configuración y gestión de service workers.
***
## Requisitos
* Aplicación y plataforma de OneSignal configuradas. Consulte [Configuración de Web Push](./web-push-setup) para comenzar.
***
## Instalación
Instale el paquete `onesignal-ngx` usando su administrador de paquetes preferido:
```bash npm theme={null}
npm install --save onesignal-ngx
```
```bash yarn theme={null}
yarn add onesignal-ngx
```
***
## Inicialización
Importe el servicio de OneSignal e inicialícelo en su componente raíz:
```typescript ts theme={null}
import { OneSignal } from 'onesignal-ngx';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent {
constructor(private oneSignal: OneSignal) {
this.oneSignal.init({
appId: 'YOUR-ONESIGNAL-APP-ID',
});
}
}
```
### Esperar la inicialización
Puede manejar la promesa devuelta por `init()` de dos maneras:
```typescript ts theme={null}
// Opción 1: async/await
await this.oneSignal.init({ appId: 'YOUR-APP-ID' });
// continuar con otra lógica
// Opción 2: .then()
this.oneSignal.init({ appId: 'YOUR-APP-ID' }).then(() => {
// seguro para interactuar con las APIs de OneSignal
});
```
### Personalizar opciones de inicialización
Puede personalizar su inicialización con [parámetros `init`](./web-sdk-reference#init) adicionales.
### Configuración del Service Worker
Para evitar conflictos con el propio service worker de Angular (usado en configuraciones PWA), especifique un alcance y ruta únicos para el service worker de OneSignal.
Si aún no lo ha hecho, necesitará [descargar el archivo Service Worker de OneSignal](https://github.com/OneSignal/OneSignal-Website-SDK/files/11480764/OneSignalSDK-v16-ServiceWorker.zip) para agregarlo a su sitio.
El archivo `OneSignalSDKWorker.js` debe ser públicamente accesible. Puede colocarlo en su directorio `public`, raíz de nivel superior o un subdirectorio. Sin embargo, si está colocando el archivo en un subdirectorio y/o tiene otro service worker para su sitio, asegúrese de especificar la ruta. Consulte [OneSignal Service Worker](./onesignal-service-worker) para más detalles.
| Opción | Descripción |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `serviceWorkerParam` | Alcance controlado por el worker de OneSignal. **Recomendación:** Use una subruta personalizada (por ejemplo, `"/onesignal/"`). |
| `serviceWorkerPath` | Ruta a su archivo de service worker de OneSignal alojado (por ejemplo, `"onesignal/OneSignalSDKWorker.js"`). Debe ser públicamente accesible. |
**Ejemplo:**
```typescript theme={null}
this.oneSignal.init({
appId: 'YOUR-APP-ID',
serviceWorkerParam: {
scope: '/onesignal/'
},
serviceWorkerPath: 'onesignal/OneSignalSDKWorker.js'
});
```
#### Alojar el worker
* Raíz pública (predeterminado): `/OneSignalSDKWorker.js`
* Carpeta personalizada (recomendado): por ejemplo, `/onesignal/OneSignalSDKWorker.js` como se establece en el paso anterior.
#### Verificar alojamiento del service worker
Visite la ruta en su navegador para confirmar que es accesible.
Si usó la raíz:
```
https://your-site.com/OneSignalSDKWorker.js
```
Si usa la ruta del ejemplo:
```
https://your-site.com/onesignal/OneSignalSDKWorker.js
```
Debería devolver JavaScript válido.
#### Importante para usuarios de Angular CLI
Si el archivo no se está sirviendo, asegúrese de que esté listado en su `angular.json` bajo el array `assets`:
```json json theme={null}
"assets": [
"src/assets",
"onesignal/OneSignalSDKWorker.js"
]
```
### Notas importantes
* Evitar inicialización duplicada en desarrollo
* Al probar en un entorno de desarrollo, podría ver que el SDK de OneSignal se inicializa dos veces, lo que puede causar errores de consola.
* Esto sucede debido a que `` hace que los efectos se ejecuten dos veces en desarrollo. Para resolverlo, elimine `` de su componente raíz durante el desarrollo.
El modo estricto solo afecta el desarrollo—no impacta las compilaciones de producción.
***
## Testing the OneSignal SDK integration
This guide helps you verify that your OneSignal SDK integration is working correctly by testing push notifications and subscription registration.
### Check web push subscriptions
* Use Chrome, Firefox, Edge, or Safari while testing.
* **Do not use Incognito or private browsing mode.** Users cannot subscribe to push notifications in these modes.
* The prompts should appear based on your [permission prompts](/docs/en/permission-requests) configuration.
* Click **Allow** on the native prompt to subscribe to push notifications.
* Go to **Audience > Subscriptions**.
* You should see a new entry with the status **Subscribed**.
You have successfully created a [web push subscription](/docs/en/subscriptions).
Web push subscriptions are created when users first subscribe to push notifications on your site.
### Set up test users
test users are helpful for testing a push notification before sending a message.
In the dashboard, next to the subscription, click the **Options (three dots)** button and select **Add to Test Users**.
Name the subscription so you can easily identify your device later in the **test users tab**.
Go to **Audience > Segments > New Segment**.
Name the segment `Test Users` (the name is important because it will be used later).
You have successfully created a segment of test users.
You can now test sending messages to this individual device and groups of test users.
### Send test push via API
In your OneSignal dashboard, go to **Settings > [Keys & IDs](/docs/en/keys-and-ids)**.
Replace `YOUR_APP_API_KEY` and `YOUR_APP_ID` in the code below with your actual keys. This code uses the `Test Users` segment created earlier.
```curl theme={null}
curl -X POST --url 'https://api.onesignal.com/notifications' \
--header 'content-type: application/json; charset=utf-8' \
--header 'authorization: Key YOUR_APP_API_KEY' \
--data '{
"app_id": "YOUR_APP_ID",
"target_channel": "push",
"name": "Testing basic setup",
"headings": {
"en": "👋"
},
"contents": {
"en": "Hello world!"
},
"included_segments": [
"Test Users"
],
"chrome_web_image": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
}'
```
Run the code in your terminal.
If all setup steps were completed successfully, the test users should receive a notification.
Only Chrome supports images. Images will appear small in the collapsed notification view. Expand the notification to see the full image.
In your dashboard, go to **Delivery > Sent Messages**, then click the message to view stats. You should see the **confirmed** stat, meaning the device received the push.
Safari does not support confirmed receipt.
View delivery, click, and conversion stats for your push notifications.
You have successfully sent a notification via the API to a segment.
If notifications are not arriving, contact `support@onesignal.com` with the following:
* The API request and response (copy-paste into a `.txt` file)
* Your Subscription ID
* Your website URL with the OneSignal code
***
## User identification
The previous section covered creating web push [Subscriptions](/docs/en/subscriptions). This section expands to identifying [Users](/docs/en/users) across all their subscriptions (including push, email, and SMS) using the OneSignal SDK. It covers External IDs, tags, multi-channel subscriptions, privacy, and event tracking to help you unify and engage users across platforms.
### Assign External ID
Use an External ID to identify users consistently across devices, email addresses, and phone numbers using your backend's user identifier. This ensures your messaging stays unified across channels and 3rd party systems (especially important for [Integrations](/docs/en/integrations)).
Set the External ID with the SDK's [`login` method](/docs/en/web-sdk-reference#login-external-id) each time a user is identified by your app.
OneSignal generates unique read-only IDs for subscriptions (Subscription ID) and users (OneSignal ID).
As users download your app on different devices, subscribe to your website, and/or provide you email addresses and phone numbers outside of your app, new subscriptions will be created.
Setting the External ID via the SDK is highly recommended to identify users across all their subscriptions, regardless of how they are created.
### Add Tags
[Tags](/docs/en/add-user-data-tags) are key-value pairs of string data you can use to store user properties (like `username`, `role`, or preferences) and events (like `purchase_date`, `game_level`, or user interactions). Tags power advanced [Message Personalization](/docs/en/message-personalization) and [Segmentation](/docs/en/segmentation) allowing for more advanced use cases.
Set tags with the SDK's [`addTag` and `addTags` methods](/docs/en/web-sdk-reference#addtag-%2C-addtags) as events occur in your app.
In this example, the user reached level 6 identifiable by the tag called `current_level` set to a value of `6`.
You can create a segment of users with a level between 5 and 10, then use that segment to send targeted and personalized messages:
### Add email and/or SMS subscriptions
The OneSignal SDK creates web push subscriptions automatically when users opt in. You can also reach users through email and SMS channels by creating the corresponding subscriptions.
* Use the [`addEmail` method](/docs/en/web-sdk-reference#addemail-%2C-removeemail) to create email subscriptions.
* Use the [`addSms` method](/docs/en/web-sdk-reference#addsms-%2C-removesms) to create SMS subscriptions.
If the email address or phone number already exists in the OneSignal app, the SDK adds it to the existing user. It does not create duplicates.
You can view unified users via **Audience > Users** in the dashboard or with the [View user API](/reference/view-user).
Best practices for multi-channel communication
* Obtain explicit consent before adding email or SMS subscriptions.
* Explain the benefits of each communication channel to users.
* Provide channel preferences so users can select which channels they prefer.
***
### Privacy & user consent
To control when OneSignal collects user data, use the SDK's consent gating methods:
* [`setConsentRequired(true)`](/docs/en/web-sdk-reference#setconsentrequired): Prevents data collection until consent is given.
* [`setConsentGiven(true)`](/docs/en/web-sdk-reference#setconsentgiven): Enables data collection once consent is granted.
For more on privacy and security:
Review what data the OneSignal SDK collects from users.
Manage and protect user data in compliance with privacy regulations.
***
## Listen to push, user, and in-app events
Use SDK listeners to react to user actions and state changes.
The SDK provides several event listeners you can hook into. See the [SDK reference guide](/docs/en/web-sdk-reference) for more details.
### Push notification events
* [Click event listener](/docs/en/web-sdk-reference#click): Detect when a notification is tapped.
* [Foreground lifecycle listener](/docs/en/web-sdk-reference#foregroundwilldisplay): Control how notifications behave in foreground.
### User state changes
* [User state change event listener](/docs/en/web-sdk-reference#addeventlistener-user-state): Detect when the External ID is set.
* [Permission observer](/docs/en/web-sdk-reference#permissionchange): Track the user's specific interaction with the native push permission prompt.
* [Push subscription change observer](/docs/en/web-sdk-reference#addeventlistener-push-subscription-changes): Track when the push subscription status changes.
***
## Advanced setup & capabilities
Explore more capabilities to enhance your integration:
Move from another push provider to OneSignal.
Connect OneSignal with third-party tools and platforms.
Add interactive buttons to push notifications.
Send localized messages to users in their preferred language.
Secure your SDK integration with server-side identity verification.
Track custom conversion events tied to your messages.
### Web SDK setup & reference
Enable all key web push features for your integration.
Full details on available methods and configuration options.
Congratulations! You've successfully completed the Web SDK setup guide.
***
Need help?
Chat with our Support team or email `support@onesignal.com`
Please include:
* Details of the issue you're experiencing and steps to reproduce if available
* Your OneSignal App ID
* The External ID or Subscription ID if applicable
* The URL to the message you tested in the OneSignal Dashboard if applicable
* Any relevant [logs or error messages](/docs/en/capturing-a-debug-log)
We're happy to help!