@internetarchive/collection-browser 2.22.1-alpha-webdev7818.5 → 2.22.1-alpha2
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/.editorconfig +29 -29
- package/.github/workflows/ci.yml +27 -27
- package/.github/workflows/gh-pages-main.yml +39 -39
- package/.github/workflows/npm-publish.yml +39 -39
- package/.github/workflows/pr-preview.yml +38 -38
- package/.husky/pre-commit +4 -4
- package/.prettierignore +1 -1
- package/LICENSE +661 -661
- package/README.md +83 -83
- package/dist/src/collection-browser.d.ts +6 -3
- package/dist/src/collection-browser.js +691 -681
- package/dist/src/collection-browser.js.map +1 -1
- package/dist/src/data-source/collection-browser-data-source-interface.js.map +1 -1
- package/dist/src/data-source/collection-browser-data-source.js.map +1 -1
- package/dist/src/manage/manage-bar.d.ts +4 -0
- package/dist/src/manage/manage-bar.js +21 -0
- package/dist/src/manage/manage-bar.js.map +1 -1
- package/dist/src/manage/remove-items-modal-content.js +0 -1
- package/dist/src/manage/remove-items-modal-content.js.map +1 -1
- package/dist/src/tiles/list/tile-list-compact-header.js +45 -45
- package/dist/src/tiles/list/tile-list-compact-header.js.map +1 -1
- package/dist/src/tiles/list/tile-list-compact.js +97 -97
- package/dist/src/tiles/list/tile-list-compact.js.map +1 -1
- package/dist/src/tiles/list/tile-list.js +289 -289
- package/dist/src/tiles/list/tile-list.js.map +1 -1
- package/dist/test/collection-browser.test.js +187 -187
- package/dist/test/collection-browser.test.js.map +1 -1
- package/eslint.config.mjs +53 -53
- package/index.html +24 -24
- package/local.archive.org.cert +86 -86
- package/local.archive.org.key +27 -27
- package/package.json +117 -117
- package/renovate.json +6 -6
- package/src/collection-browser.ts +2763 -2755
- package/src/data-source/collection-browser-data-source-interface.ts +333 -333
- package/src/data-source/collection-browser-data-source.ts +1390 -1390
- package/src/manage/manage-bar.ts +23 -0
- package/src/manage/remove-items-modal-content.ts +0 -1
- package/src/tiles/list/tile-list-compact-header.ts +86 -86
- package/src/tiles/list/tile-list-compact.ts +236 -236
- package/src/tiles/list/tile-list.ts +688 -688
- package/test/collection-browser.test.ts +2359 -2359
- package/tsconfig.json +20 -20
- package/web-dev-server.config.mjs +30 -30
- package/web-test-runner.config.mjs +41 -41
package/README.md
CHANGED
|
@@ -1,84 +1,84 @@
|
|
|
1
|
-
 [](https://codecov.io/gh/internetarchive/iaux-collection-browser)
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
# Internet Archive Collection Browser
|
|
5
|
-
|
|
6
|
-
This is the main collection browser for the Internet Archive website.
|
|
7
|
-
|
|
8
|
-
[Review app URL](https://internetarchive.github.io/iaux-collection-browser/main)
|
|
9
|
-
## Usage
|
|
10
|
-
|
|
11
|
-
```ts
|
|
12
|
-
import '@internetarchive/collection-browser';
|
|
13
|
-
|
|
14
|
-
<collection-browser>
|
|
15
|
-
</collection-browser>
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
## Local Demo with `web-dev-server`
|
|
19
|
-
```bash
|
|
20
|
-
yarn install
|
|
21
|
-
yarn start
|
|
22
|
-
```
|
|
23
|
-
To run a local development server that serves the basic demo located in `index.html`
|
|
24
|
-
|
|
25
|
-
## Testing with Web Test Runner
|
|
26
|
-
To run the suite of Web Test Runner tests, run
|
|
27
|
-
```bash
|
|
28
|
-
yarn run test
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
To run the tests in watch mode (for <abbr title="test driven development">TDD</abbr>, for example), run
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
yarn run test:watch
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
## Linting with ESLint, Prettier, and Types
|
|
38
|
-
To scan the project for linting errors, run
|
|
39
|
-
```bash
|
|
40
|
-
yarn run lint
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
You can lint with ESLint and Prettier individually as well
|
|
44
|
-
```bash
|
|
45
|
-
yarn run lint:eslint
|
|
46
|
-
```
|
|
47
|
-
```bash
|
|
48
|
-
yarn run lint:prettier
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
To automatically fix many linting errors, run
|
|
52
|
-
```bash
|
|
53
|
-
yarn run format
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
You can format using ESLint and Prettier individually as well
|
|
57
|
-
```bash
|
|
58
|
-
yarn run format:eslint
|
|
59
|
-
```
|
|
60
|
-
```bash
|
|
61
|
-
yarn run format:prettier
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
## Tooling configs
|
|
65
|
-
|
|
66
|
-
For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
|
|
67
|
-
|
|
68
|
-
If you customize the configuration a lot, you can consider moving them to individual files.
|
|
69
|
-
|
|
70
|
-
## Manual Deploy using `gh-pages`
|
|
71
|
-
|
|
72
|
-
Live demo app from current main branch: [https://internetarchive.github.io/iaux-collection-browser](https://internetarchive.github.io/iaux-collection-browser)
|
|
73
|
-
|
|
74
|
-
```
|
|
75
|
-
yarn run deploy
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
## Automatic Deploy of Demo App
|
|
79
|
-
|
|
80
|
-
When you create a Pull Request, if your code passes codecov unit tests, it will be always served live at base url / pull request number. For this demo app, you must create a Pull Request, nothing will be created from a simple branch.
|
|
81
|
-
|
|
82
|
-
This URL will be removed when the Pull Request is merged/closed.
|
|
83
|
-
|
|
1
|
+
 [](https://codecov.io/gh/internetarchive/iaux-collection-browser)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
# Internet Archive Collection Browser
|
|
5
|
+
|
|
6
|
+
This is the main collection browser for the Internet Archive website.
|
|
7
|
+
|
|
8
|
+
[Review app URL](https://internetarchive.github.io/iaux-collection-browser/main)
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
import '@internetarchive/collection-browser';
|
|
13
|
+
|
|
14
|
+
<collection-browser>
|
|
15
|
+
</collection-browser>
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Local Demo with `web-dev-server`
|
|
19
|
+
```bash
|
|
20
|
+
yarn install
|
|
21
|
+
yarn start
|
|
22
|
+
```
|
|
23
|
+
To run a local development server that serves the basic demo located in `index.html`
|
|
24
|
+
|
|
25
|
+
## Testing with Web Test Runner
|
|
26
|
+
To run the suite of Web Test Runner tests, run
|
|
27
|
+
```bash
|
|
28
|
+
yarn run test
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
To run the tests in watch mode (for <abbr title="test driven development">TDD</abbr>, for example), run
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
yarn run test:watch
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Linting with ESLint, Prettier, and Types
|
|
38
|
+
To scan the project for linting errors, run
|
|
39
|
+
```bash
|
|
40
|
+
yarn run lint
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
You can lint with ESLint and Prettier individually as well
|
|
44
|
+
```bash
|
|
45
|
+
yarn run lint:eslint
|
|
46
|
+
```
|
|
47
|
+
```bash
|
|
48
|
+
yarn run lint:prettier
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
To automatically fix many linting errors, run
|
|
52
|
+
```bash
|
|
53
|
+
yarn run format
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
You can format using ESLint and Prettier individually as well
|
|
57
|
+
```bash
|
|
58
|
+
yarn run format:eslint
|
|
59
|
+
```
|
|
60
|
+
```bash
|
|
61
|
+
yarn run format:prettier
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Tooling configs
|
|
65
|
+
|
|
66
|
+
For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
|
|
67
|
+
|
|
68
|
+
If you customize the configuration a lot, you can consider moving them to individual files.
|
|
69
|
+
|
|
70
|
+
## Manual Deploy using `gh-pages`
|
|
71
|
+
|
|
72
|
+
Live demo app from current main branch: [https://internetarchive.github.io/iaux-collection-browser](https://internetarchive.github.io/iaux-collection-browser)
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
yarn run deploy
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Automatic Deploy of Demo App
|
|
79
|
+
|
|
80
|
+
When you create a Pull Request, if your code passes codecov unit tests, it will be always served live at base url / pull request number. For this demo app, you must create a Pull Request, nothing will be created from a simple branch.
|
|
81
|
+
|
|
82
|
+
This URL will be removed when the Pull Request is merged/closed.
|
|
83
|
+
|
|
84
84
|
Example: `https://internetarchive.github.io/iaux-collection-browser/pr/<pr-number>`
|
|
@@ -158,10 +158,9 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
|
|
|
158
158
|
manageViewLabel: string;
|
|
159
159
|
/** Whether to replace the default sort options with a slot for customization (default: false) */
|
|
160
160
|
enableSortOptionsSlot: boolean;
|
|
161
|
-
/** Whether to
|
|
161
|
+
/** Whether to display a smart results carousel above the full results */
|
|
162
162
|
showSmartResults: boolean;
|
|
163
|
-
|
|
164
|
-
resultsHeader?: TemplateResult | string;
|
|
163
|
+
resultsHeader?: string;
|
|
165
164
|
/**
|
|
166
165
|
* The maximum number of pages we will load when a privileged user clicks
|
|
167
166
|
* the "Manage" button on the search page. Limited to 15 pages.
|
|
@@ -367,6 +366,10 @@ export declare class CollectionBrowser extends LitElement implements InfiniteScr
|
|
|
367
366
|
*/
|
|
368
367
|
private handleManageItems;
|
|
369
368
|
refreshSmartFacets(): void;
|
|
369
|
+
/**
|
|
370
|
+
* Handler to show success modal when item removal succeeded
|
|
371
|
+
*/
|
|
372
|
+
showRemoveItemsSuccessModal(): void;
|
|
370
373
|
/**
|
|
371
374
|
* Handler to show processing modal while removing item
|
|
372
375
|
*/
|