@ionic/portals

SDK Plugin for Ionic Portals

Usage no npm install needed!

<script type="module">
  import ionicPortals from 'https://cdn.skypack.dev/@ionic/portals';
</script>

README

Ionic Portals

Plugin SDK for Ionic Portals

Install

npm install @ionic/portals

API

getInitialContext()

getInitialContext<T = unknown>() => any

Returns: any

publish(...)

publish<TData>(message: PortalMessage<TData>) => any
Param Type
message PortalMessage<TData>

Returns: any

subscribe(...)

subscribe<T = unknown>(options: SubscribeOptions, callback: SubscriptionCallback<T>) => any
Param Type
options SubscribeOptions
callback (result: { topic: string; data: T; }) => void

Returns: any

unsubscribe(...)

unsubscribe(options: PortalSubscription) => any
Param Type
options PortalSubscription

Returns: any

Interfaces

InitialContext

Prop Type
name string
value T

PortalMessage

Prop Type
topic string
data TData

SubscribeOptions

Prop Type
topic string

PortalSubscription

Prop Type
subscriptionRef number
topic string