@atlaskit/editor-plugin-emoji 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md ADDED
@@ -0,0 +1 @@
1
+ # @atlaskit/editor-plugin-emoji
package/LICENSE.md ADDED
@@ -0,0 +1,13 @@
1
+ Copyright 2023 Atlassian Pty Ltd
2
+
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+
7
+ http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ Unless required by applicable law or agreed to in writing, software
10
+ distributed under the License is distributed on an "AS IS" BASIS,
11
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ See the License for the specific language governing permissions and
13
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,9 @@
1
+ # EditorPluginEmoji
2
+
3
+ Emoji plugin for @atlaskit/editor-core
4
+
5
+ ## Usage
6
+
7
+ `import { EmojiPlugin } from '@atlaskit/editor-plugin-emoji';`
8
+
9
+ Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-emoji).
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export type { EmojiPlugin, EmojiPluginOptions, EmojiPluginState, } from './types';
@@ -0,0 +1,22 @@
1
+ import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
2
+ import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
3
+ import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
4
+ import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
5
+ import type { EmojiId } from '@atlaskit/emoji';
6
+ import type { EmojiDescription, EmojiProvider, EmojiResourceConfig } from '@atlaskit/emoji';
7
+ export interface EmojiPluginOptions {
8
+ headless?: boolean;
9
+ }
10
+ export type EmojiPluginState = {
11
+ emojiProvider?: EmojiProvider;
12
+ emojiResourceConfig?: EmojiResourceConfig;
13
+ asciiMap?: Map<string, EmojiDescription>;
14
+ };
15
+ export type EmojiPlugin = NextEditorPlugin<'emoji', {
16
+ pluginConfiguration: EmojiPluginOptions | undefined;
17
+ dependencies: [OptionalPlugin<typeof analyticsPlugin>, TypeAheadPlugin];
18
+ sharedState: EmojiPluginState | undefined;
19
+ commands: {
20
+ insertEmoji: (emojiId: EmojiId, inputMethod?: INPUT_METHOD.PICKER | INPUT_METHOD.ASCII | INPUT_METHOD.TYPEAHEAD) => EditorCommand;
21
+ };
22
+ }>;
@@ -0,0 +1 @@
1
+ export type { EmojiPlugin, EmojiPluginOptions, EmojiPluginState, } from './types';
@@ -0,0 +1,25 @@
1
+ import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
2
+ import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
3
+ import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
4
+ import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
5
+ import type { EmojiId } from '@atlaskit/emoji';
6
+ import type { EmojiDescription, EmojiProvider, EmojiResourceConfig } from '@atlaskit/emoji';
7
+ export interface EmojiPluginOptions {
8
+ headless?: boolean;
9
+ }
10
+ export type EmojiPluginState = {
11
+ emojiProvider?: EmojiProvider;
12
+ emojiResourceConfig?: EmojiResourceConfig;
13
+ asciiMap?: Map<string, EmojiDescription>;
14
+ };
15
+ export type EmojiPlugin = NextEditorPlugin<'emoji', {
16
+ pluginConfiguration: EmojiPluginOptions | undefined;
17
+ dependencies: [
18
+ OptionalPlugin<typeof analyticsPlugin>,
19
+ TypeAheadPlugin
20
+ ];
21
+ sharedState: EmojiPluginState | undefined;
22
+ commands: {
23
+ insertEmoji: (emojiId: EmojiId, inputMethod?: INPUT_METHOD.PICKER | INPUT_METHOD.ASCII | INPUT_METHOD.TYPEAHEAD) => EditorCommand;
24
+ };
25
+ }>;
package/package.json ADDED
@@ -0,0 +1,90 @@
1
+ {
2
+ "name": "@atlaskit/editor-plugin-emoji",
3
+ "version": "0.1.0",
4
+ "description": "Emoji plugin for @atlaskit/editor-core",
5
+ "author": "Atlassian Pty Ltd",
6
+ "license": "Apache-2.0",
7
+ "publishConfig": {
8
+ "registry": "https://registry.npmjs.org/"
9
+ },
10
+ "atlassian": {
11
+ "team": "Editor",
12
+ "releaseModel": "continuous",
13
+ "singleton": true
14
+ },
15
+ "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
16
+ "main": "dist/cjs/index.js",
17
+ "module": "dist/esm/index.js",
18
+ "module:es2019": "dist/es2019/index.js",
19
+ "types": "dist/types/index.d.ts",
20
+ "typesVersions": {
21
+ ">=4.5 <4.9": {
22
+ "*": [
23
+ "dist/types-ts4.5/*",
24
+ "dist/types-ts4.5/index.d.ts"
25
+ ]
26
+ }
27
+ },
28
+ "sideEffects": false,
29
+ "atlaskit:src": "src/index.ts",
30
+ "af:exports": {
31
+ ".": "./src/index.ts"
32
+ },
33
+ "dependencies": {
34
+ "@atlaskit/editor-common": "^74.50.0",
35
+ "@babel/runtime": "^7.0.0"
36
+ },
37
+ "peerDependencies": {
38
+ "react": "^16.8.0"
39
+ },
40
+ "devDependencies": {
41
+ "@af/visual-regression": "*",
42
+ "@atlaskit/ssr": "*",
43
+ "@atlaskit/visual-regression": "*",
44
+ "@atlaskit/webdriver-runner": "*",
45
+ "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
46
+ "@testing-library/react": "^12.1.5",
47
+ "react-dom": "^16.8.0",
48
+ "typescript": "~4.9.5",
49
+ "wait-for-expect": "^1.2.0"
50
+ },
51
+ "techstack": {
52
+ "@atlassian/frontend": {
53
+ "code-structure": [
54
+ "tangerine-next"
55
+ ],
56
+ "import-structure": [
57
+ "atlassian-conventions"
58
+ ],
59
+ "circular-dependencies": [
60
+ "file-and-folder-level"
61
+ ]
62
+ },
63
+ "@repo/internal": {
64
+ "dom-events": "use-bind-event-listener",
65
+ "analytics": [
66
+ "analytics-next"
67
+ ],
68
+ "design-tokens": [
69
+ "color"
70
+ ],
71
+ "theming": [
72
+ "react-context"
73
+ ],
74
+ "ui-components": [
75
+ "lite-mode"
76
+ ],
77
+ "deprecation": [
78
+ "no-deprecated-imports"
79
+ ],
80
+ "styling": [
81
+ "static",
82
+ "emotion"
83
+ ],
84
+ "imports": [
85
+ "import-no-extraneous-disable-for-examples-and-docs"
86
+ ]
87
+ }
88
+ },
89
+ "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
90
+ }
package/report.api.md ADDED
@@ -0,0 +1,76 @@
1
+ <!-- API Report Version: 2.3 -->
2
+
3
+ ## API Report File for "@atlaskit/editor-plugin-emoji"
4
+
5
+ > Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
6
+ > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
7
+
8
+ ### Table of contents
9
+
10
+ - [Main Entry Types](#main-entry-types)
11
+ - [Peer Dependencies](#peer-dependencies)
12
+
13
+ ### Main Entry Types
14
+
15
+ <!--SECTION START: Main Entry Types-->
16
+
17
+ ```ts
18
+ import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
19
+ import type { EditorCommand } from '@atlaskit/editor-common/types';
20
+ import type { EmojiDescription } from '@atlaskit/emoji';
21
+ import type { EmojiId } from '@atlaskit/emoji';
22
+ import type { EmojiProvider } from '@atlaskit/emoji';
23
+ import type { EmojiResourceConfig } from '@atlaskit/emoji';
24
+ import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
25
+ import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
26
+ import type { OptionalPlugin } from '@atlaskit/editor-common/types';
27
+ import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
28
+
29
+ // @public (undocumented)
30
+ export type EmojiPlugin = NextEditorPlugin<
31
+ 'emoji',
32
+ {
33
+ pluginConfiguration: EmojiPluginOptions | undefined;
34
+ dependencies: [OptionalPlugin<typeof analyticsPlugin>, TypeAheadPlugin];
35
+ sharedState: EmojiPluginState | undefined;
36
+ commands: {
37
+ insertEmoji: (
38
+ emojiId: EmojiId,
39
+ inputMethod?:
40
+ | INPUT_METHOD.ASCII
41
+ | INPUT_METHOD.PICKER
42
+ | INPUT_METHOD.TYPEAHEAD,
43
+ ) => EditorCommand;
44
+ };
45
+ }
46
+ >;
47
+
48
+ // @public (undocumented)
49
+ export interface EmojiPluginOptions {
50
+ // (undocumented)
51
+ headless?: boolean;
52
+ }
53
+
54
+ // @public (undocumented)
55
+ export type EmojiPluginState = {
56
+ emojiProvider?: EmojiProvider;
57
+ emojiResourceConfig?: EmojiResourceConfig;
58
+ asciiMap?: Map<string, EmojiDescription>;
59
+ };
60
+
61
+ // (No @packageDocumentation comment for this package)
62
+ ```
63
+
64
+ <!--SECTION END: Main Entry Types-->
65
+
66
+ ### Peer Dependencies
67
+
68
+ <!--SECTION START: Peer Dependencies-->
69
+
70
+ ```json
71
+ {
72
+ "react": "^16.8.0"
73
+ }
74
+ ```
75
+
76
+ <!--SECTION END: Peer Dependencies-->
@@ -0,0 +1,43 @@
1
+ ## API Report File for "@atlaskit/editor-plugin-emoji"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
8
+ import type { EditorCommand } from '@atlaskit/editor-common/types';
9
+ import type { EmojiDescription } from '@atlaskit/emoji';
10
+ import type { EmojiId } from '@atlaskit/emoji';
11
+ import type { EmojiProvider } from '@atlaskit/emoji';
12
+ import type { EmojiResourceConfig } from '@atlaskit/emoji';
13
+ import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
14
+ import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
15
+ import type { OptionalPlugin } from '@atlaskit/editor-common/types';
16
+ import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
17
+
18
+ // @public (undocumented)
19
+ export type EmojiPlugin = NextEditorPlugin<'emoji', {
20
+ pluginConfiguration: EmojiPluginOptions | undefined;
21
+ dependencies: [OptionalPlugin<typeof analyticsPlugin>, TypeAheadPlugin];
22
+ sharedState: EmojiPluginState | undefined;
23
+ commands: {
24
+ insertEmoji: (emojiId: EmojiId, inputMethod?: INPUT_METHOD.ASCII | INPUT_METHOD.PICKER | INPUT_METHOD.TYPEAHEAD) => EditorCommand;
25
+ };
26
+ }>;
27
+
28
+ // @public (undocumented)
29
+ export interface EmojiPluginOptions {
30
+ // (undocumented)
31
+ headless?: boolean;
32
+ }
33
+
34
+ // @public (undocumented)
35
+ export type EmojiPluginState = {
36
+ emojiProvider?: EmojiProvider;
37
+ emojiResourceConfig?: EmojiResourceConfig;
38
+ asciiMap?: Map<string, EmojiDescription>;
39
+ };
40
+
41
+ // (No @packageDocumentation comment for this package)
42
+
43
+ ```