Skip to content

Commit

Permalink
docs: use typedoc+markdown plugin for docs.page compatible reference
Browse files Browse the repository at this point in the history
- use mdx file extension since that's what docs.page expects
- use flat output so relative links don't have pathing issues on docs.page
- use main branch vs git revision in source links
- set entry file name to `index`
- add custom `@platform` typedoc comment
- bend generated internal links to match docs.page URL auto-linking path components
 - strip .mdx from end of URL path
 - add prefix path components
  • Loading branch information
mikehardy committed Dec 19, 2024
1 parent 090ab68 commit 232b864
Show file tree
Hide file tree
Showing 68 changed files with 7,719 additions and 39 deletions.
61 changes: 61 additions & 0 deletions docs/react-native/reference/Enumeration.AlarmType.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
[**@notifee/react-native**](react-native/reference/index)

***

[@notifee/react-native](react-native/reference/index) / AlarmType

# Enumeration: AlarmType

An interface representing the different alarm types which can be used with `TimestampTrigger.alarmManager.type`.

View the [Triggers](/react-native/docs/triggers) documentation to learn more.

## Enumeration Members

### SET

> **SET**: `0`
#### Defined in

[packages/react-native/src/types/Trigger.ts:43](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/Trigger.ts#L43)

***

### SET\_ALARM\_CLOCK

> **SET\_ALARM\_CLOCK**: `4`
#### Defined in

[packages/react-native/src/types/Trigger.ts:47](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/Trigger.ts#L47)

***

### SET\_AND\_ALLOW\_WHILE\_IDLE

> **SET\_AND\_ALLOW\_WHILE\_IDLE**: `1`
#### Defined in

[packages/react-native/src/types/Trigger.ts:44](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/Trigger.ts#L44)

***

### SET\_EXACT

> **SET\_EXACT**: `2`
#### Defined in

[packages/react-native/src/types/Trigger.ts:45](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/Trigger.ts#L45)

***

### SET\_EXACT\_AND\_ALLOW\_WHILE\_IDLE

> **SET\_EXACT\_AND\_ALLOW\_WHILE\_IDLE**: `3`
#### Defined in

[packages/react-native/src/types/Trigger.ts:46](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/Trigger.ts#L46)
53 changes: 53 additions & 0 deletions docs/react-native/reference/Enumeration.AndroidBadgeIconType.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
[**@notifee/react-native**](react-native/reference/index)

***

[@notifee/react-native](react-native/reference/index) / AndroidBadgeIconType

# Enumeration: AndroidBadgeIconType

Enum used to define how a notification badge is displayed in badge mode.

View the [Badges](/react-native/docs/android/appearance#badges) documentation for more information.

## Platform

android

## Enumeration Members

### LARGE

> **LARGE**: `2`
Shows the badge as the notifications `largeIcon` (if available).

This is the default value used by a notification if not provided.

#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1092](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1092)

***

### NONE

> **NONE**: `0`
No badge is displayed, will always show as a number.

#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1080](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1080)

***

### SMALL

> **SMALL**: `1`
Shows the badge as the notifications `smallIcon`.

#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1085](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1085)
179 changes: 179 additions & 0 deletions docs/react-native/reference/Enumeration.AndroidCategory.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
[**@notifee/react-native**](react-native/reference/index)

***

[@notifee/react-native](react-native/reference/index) / AndroidCategory

# Enumeration: AndroidCategory

Enum used to describe the category of a notification.

Setting a category on a notification helps the device to understand what the notification is for,
or what impact it will have on the user. The category can be used for ranking and filtering
the notification, however has no visual impact on the notification.

## Platform

android

## Enumeration Members

### ALARM

> **ALARM**: `"alarm"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1105](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1105)

***

### CALL

> **CALL**: `"call"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1106](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1106)

***

### EMAIL

> **EMAIL**: `"email"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1107](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1107)

***

### ERROR

> **ERROR**: `"error"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1108](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1108)

***

### EVENT

> **EVENT**: `"event"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1109](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1109)

***

### MESSAGE

> **MESSAGE**: `"msg"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1110](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1110)

***

### NAVIGATION

> **NAVIGATION**: `"navigation"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1111](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1111)

***

### PROGRESS

> **PROGRESS**: `"progress"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1112](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1112)

***

### PROMO

> **PROMO**: `"promo"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1113](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1113)

***

### RECOMMENDATION

> **RECOMMENDATION**: `"recommendation"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1114](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1114)

***

### REMINDER

> **REMINDER**: `"reminder"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1115](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1115)

***

### SERVICE

> **SERVICE**: `"service"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1116](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1116)

***

### SOCIAL

> **SOCIAL**: `"social"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1117](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1117)

***

### STATUS

> **STATUS**: `"status"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1118](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1118)

***

### SYSTEM

> **SYSTEM**: `"sys"`
Avoid using - generally used by the system.

#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1123](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1123)

***

### TRANSPORT

> **TRANSPORT**: `"transport"`
#### Defined in

[packages/react-native/src/types/NotificationAndroid.ts:1124](https://github.com/invertase/notifee/blob/main/packages/react-native/src/types/NotificationAndroid.ts#L1124)
Loading

0 comments on commit 232b864

Please sign in to comment.