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

Update designing-api.md #313

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/plugins/tutorial/designing-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ Populate `definitions.ts` with the following code:
```typescript
import type { PluginListenerHandle } from '@capacitor/core';

export declare type OrientationLockType = 'any' | 'natural' | 'landscape' | 'portrait' | 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary';

export interface ScreenOrientationPlugin {
/**
* Returns the screen's current orientation.
Expand All @@ -67,7 +69,7 @@ export interface ScreenOrientationPlugin {
addListener(
eventName: 'screenOrientationChange',
listenerFunc: (orientation: { type: OrientationType }) => void,
): Promise<PluginListenerHandle> & PluginListenerHandle;
): Promise<PluginListenerHandle>;

/**
* Removes all listeners
Expand Down