@atlaskit/spotlight 0.0.2

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,9 @@
1
+ # @atlaskit/spotlight
2
+
3
+ ## 0.0.2
4
+
5
+ ### Patch Changes
6
+
7
+ - [#189418](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/189418)
8
+ [`3f609b46c1aec`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3f609b46c1aec) -
9
+ Create initial @atlaskit/spotlight package scaffold.
package/LICENSE.md ADDED
@@ -0,0 +1,11 @@
1
+ Copyright 2023 Atlassian Pty Ltd
2
+
3
+ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
4
+ compliance with the License. You may obtain a copy of the License at
5
+
6
+ http://www.apache.org/licenses/LICENSE-2.0
7
+
8
+ Unless required by applicable law or agreed to in writing, software distributed under the License is
9
+ distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
10
+ implied. See the License for the specific language governing permissions and limitations under the
11
+ License.
package/README.md ADDED
@@ -0,0 +1,13 @@
1
+ # Spotlight
2
+
3
+ Note: This package is in pre-alpha. It is not ready to be consumed and used.
4
+
5
+ A spotlight introduces users to various points of interest across Atlassian through focused messages
6
+ or multi-step tours.
7
+
8
+ ## Usage
9
+
10
+ `import { Spotlight } from '@atlaskit/spotlight';`
11
+
12
+ Detailed docs and example usage can be found
13
+ [here](https://atlaskit.atlassian.com/packages/design-system/spotlight).
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ Object.defineProperty(exports, "Spotlight", {
7
+ enumerable: true,
8
+ get: function get() {
9
+ return _spotlight.Spotlight;
10
+ }
11
+ });
12
+ var _spotlight = require("./ui/spotlight");
@@ -0,0 +1,25 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.Spotlight = void 0;
8
+ var _react = _interopRequireDefault(require("react"));
9
+ // TODO: Fill in the component {description} and ensure links point to the correct {packageName} location.
10
+ // Remove links that the component does not have (such as usage). If there are no links remove them all.
11
+ /**
12
+ * __Spotlight__
13
+ *
14
+ * A spotlight {description}.
15
+ *
16
+ * - [Examples](https://atlassian.design/components/{packageName}/examples)
17
+ * - [Code](https://atlassian.design/components/{packageName}/code)
18
+ * - [Usage](https://atlassian.design/components/{packageName}/usage)
19
+ */
20
+ var Spotlight = exports.Spotlight = function Spotlight(_ref) {
21
+ var testId = _ref.testId;
22
+ return /*#__PURE__*/_react.default.createElement("div", {
23
+ "data-testid": testId
24
+ }, "TODO");
25
+ };
@@ -0,0 +1 @@
1
+ export { Spotlight } from './ui/spotlight';
@@ -0,0 +1,19 @@
1
+ import React from 'react';
2
+ // TODO: Fill in the component {description} and ensure links point to the correct {packageName} location.
3
+ // Remove links that the component does not have (such as usage). If there are no links remove them all.
4
+ /**
5
+ * __Spotlight__
6
+ *
7
+ * A spotlight {description}.
8
+ *
9
+ * - [Examples](https://atlassian.design/components/{packageName}/examples)
10
+ * - [Code](https://atlassian.design/components/{packageName}/code)
11
+ * - [Usage](https://atlassian.design/components/{packageName}/usage)
12
+ */
13
+ export const Spotlight = ({
14
+ testId
15
+ }) => {
16
+ return /*#__PURE__*/React.createElement("div", {
17
+ "data-testid": testId
18
+ }, "TODO");
19
+ };
@@ -0,0 +1 @@
1
+ export { Spotlight } from './ui/spotlight';
@@ -0,0 +1,18 @@
1
+ import React from 'react';
2
+ // TODO: Fill in the component {description} and ensure links point to the correct {packageName} location.
3
+ // Remove links that the component does not have (such as usage). If there are no links remove them all.
4
+ /**
5
+ * __Spotlight__
6
+ *
7
+ * A spotlight {description}.
8
+ *
9
+ * - [Examples](https://atlassian.design/components/{packageName}/examples)
10
+ * - [Code](https://atlassian.design/components/{packageName}/code)
11
+ * - [Usage](https://atlassian.design/components/{packageName}/usage)
12
+ */
13
+ export var Spotlight = function Spotlight(_ref) {
14
+ var testId = _ref.testId;
15
+ return /*#__PURE__*/React.createElement("div", {
16
+ "data-testid": testId
17
+ }, "TODO");
18
+ };
@@ -0,0 +1 @@
1
+ export { Spotlight } from './ui/spotlight';
@@ -0,0 +1,15 @@
1
+ import React from 'react';
2
+ interface SpotlightProps {
3
+ testId?: string;
4
+ }
5
+ /**
6
+ * __Spotlight__
7
+ *
8
+ * A spotlight {description}.
9
+ *
10
+ * - [Examples](https://atlassian.design/components/{packageName}/examples)
11
+ * - [Code](https://atlassian.design/components/{packageName}/code)
12
+ * - [Usage](https://atlassian.design/components/{packageName}/usage)
13
+ */
14
+ export declare const Spotlight: ({ testId }: SpotlightProps) => React.JSX.Element;
15
+ export {};
@@ -0,0 +1 @@
1
+ export { Spotlight } from './ui/spotlight';
@@ -0,0 +1,15 @@
1
+ import React from 'react';
2
+ interface SpotlightProps {
3
+ testId?: string;
4
+ }
5
+ /**
6
+ * __Spotlight__
7
+ *
8
+ * A spotlight {description}.
9
+ *
10
+ * - [Examples](https://atlassian.design/components/{packageName}/examples)
11
+ * - [Code](https://atlassian.design/components/{packageName}/code)
12
+ * - [Usage](https://atlassian.design/components/{packageName}/usage)
13
+ */
14
+ export declare const Spotlight: ({ testId }: SpotlightProps) => React.JSX.Element;
15
+ export {};
package/package.json ADDED
@@ -0,0 +1,91 @@
1
+ {
2
+ "name": "@atlaskit/spotlight",
3
+ "version": "0.0.2",
4
+ "description": "A spotlight introduces users to various points of interest across Atlassian through focused messages or multi-step tours.",
5
+ "author": "Atlassian Pty Ltd",
6
+ "license": "Apache-2.0",
7
+ "atlassian": {
8
+ "team": "Design System Team"
9
+ },
10
+ "homepage": "https://atlassian.design/components/spotlight/",
11
+ "repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
12
+ "main": "dist/cjs/index.js",
13
+ "module": "dist/esm/index.js",
14
+ "module:es2019": "dist/es2019/index.js",
15
+ "types": "dist/types/index.d.ts",
16
+ "typesVersions": {
17
+ ">=4.5 <5.4": {
18
+ "*": [
19
+ "dist/types-ts4.5/*",
20
+ "dist/types-ts4.5/index.d.ts"
21
+ ]
22
+ }
23
+ },
24
+ "sideEffects": [
25
+ "*.compiled.css"
26
+ ],
27
+ "atlaskit:src": "src/index.tsx",
28
+ "af:exports": {
29
+ ".": "./src/index.tsx"
30
+ },
31
+ "dependencies": {
32
+ "@atlaskit/css": "^0.12.0",
33
+ "@atlaskit/primitives": "^14.10.0",
34
+ "@atlaskit/tokens": "^5.6.0",
35
+ "@babel/runtime": "^7.0.0",
36
+ "@compiled/react": "^0.18.3"
37
+ },
38
+ "peerDependencies": {
39
+ "react": "^18.2.0"
40
+ },
41
+ "devDependencies": {
42
+ "@af/integration-testing": "workspace:^",
43
+ "@af/visual-regression": "workspace:^",
44
+ "@atlaskit/ssr": "workspace:^",
45
+ "@atlaskit/visual-regression": "workspace:^",
46
+ "@testing-library/react": "^13.4.0",
47
+ "react-dom": "^18.2.0",
48
+ "typescript": "~5.4.2"
49
+ },
50
+ "techstack": {
51
+ "@atlassian/frontend": {
52
+ "code-structure": [
53
+ "tangerine-next"
54
+ ],
55
+ "import-structure": [
56
+ "atlassian-conventions"
57
+ ],
58
+ "circular-dependencies": [
59
+ "file-and-folder-level"
60
+ ]
61
+ },
62
+ "@repo/internal": {
63
+ "dom-events": "use-bind-event-listener",
64
+ "analytics": [
65
+ "analytics-next"
66
+ ],
67
+ "design-tokens": [
68
+ "color"
69
+ ],
70
+ "theming": [
71
+ "react-context"
72
+ ],
73
+ "ui-components": [
74
+ "lite-mode"
75
+ ],
76
+ "deprecation": [
77
+ "no-deprecated-imports"
78
+ ],
79
+ "styling": [
80
+ "static",
81
+ "compiled"
82
+ ],
83
+ "imports": [
84
+ "import-no-extraneous-disable-for-examples-and-docs"
85
+ ]
86
+ }
87
+ },
88
+ "publishConfig": {
89
+ "registry": "https://registry.npmjs.org/"
90
+ }
91
+ }