@ndla/image-search 11.0.17-alpha.0 → 11.0.19-alpha.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/README.md +34 -3
- package/dist/panda.buildinfo.json +34 -0
- package/dist/styles.css +108 -0
- package/es/ImageMeta.js +4 -24
- package/es/ImageSearch.js +163 -193
- package/es/ImageSearchResult.js +47 -40
- package/es/PreviewImage.js +154 -87
- package/lib/ImageMeta.js +6 -24
- package/lib/ImageSearch.d.ts +23 -22
- package/lib/ImageSearch.js +163 -191
- package/lib/ImageSearchResult.d.ts +9 -4
- package/lib/ImageSearchResult.js +49 -40
- package/lib/PreviewImage.d.ts +10 -3
- package/lib/PreviewImage.js +154 -87
- package/package.json +13 -19
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ndla-
|
|
1
|
+
# ndla-image-search
|
|
2
2
|
|
|
3
3
|
A simple library for selecting images from NDLA.
|
|
4
4
|
|
|
@@ -12,14 +12,45 @@ yarn add @ndla/image-search
|
|
|
12
12
|
npm install @ndla/image-search
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
+
## Example usage
|
|
16
|
+
|
|
15
17
|
### Get image with the image selector
|
|
16
18
|
|
|
19
|
+
To use the `ImageSearch` component, you will need to provide translations and functions for searching, handling image selection and error handling.
|
|
20
|
+
|
|
17
21
|
```js
|
|
18
22
|
import ImageSearch from "@ndla/image-search";
|
|
19
23
|
|
|
20
|
-
const
|
|
24
|
+
const onImageSelect = (image) => {
|
|
21
25
|
// handle image
|
|
22
26
|
};
|
|
23
27
|
|
|
24
|
-
|
|
28
|
+
const searchImages = (query, page) => {
|
|
29
|
+
//return a promise
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
const onError = (err) => void
|
|
33
|
+
|
|
34
|
+
const translations = {
|
|
35
|
+
close: "Lukk",
|
|
36
|
+
searchPlaceholder: "Søk i bilder",
|
|
37
|
+
searchButtonTitle: "Søk",
|
|
38
|
+
useImageTitle: "Bruk bildet",
|
|
39
|
+
checkboxLabel: "Sett som metabilde",
|
|
40
|
+
imageMetadata: {
|
|
41
|
+
creatorsLabel: "Bilde",
|
|
42
|
+
license: "Lisens",
|
|
43
|
+
caption: "Bildetekst",
|
|
44
|
+
altText: "Alt-tekst",
|
|
45
|
+
modelRelease: "Modellklarert",
|
|
46
|
+
tags: "Emneknagger",
|
|
47
|
+
},
|
|
48
|
+
paginationTranslations: {
|
|
49
|
+
rootLabel: "Sidenavigering",
|
|
50
|
+
prevTriggerLabel: "Forrige side",
|
|
51
|
+
nextTriggerLabel: "Neste side",
|
|
52
|
+
},
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
<ImageSearch onImageSelect={onImageSelect} searchImages={searchImages} onError={onError} translations={translations} locale="nb"/>;
|
|
25
56
|
```
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "0.45.2",
|
|
3
|
+
"styles": {
|
|
4
|
+
"atomic": [
|
|
5
|
+
"display]___[value:flex",
|
|
6
|
+
"flexDirection]___[value:column",
|
|
7
|
+
"gap]___[value:small",
|
|
8
|
+
"display]___[value:grid",
|
|
9
|
+
"gridTemplateColumns]___[value:repeat(auto-fit, minmax(200px, 1fr))",
|
|
10
|
+
"gridGap]___[value:xsmall",
|
|
11
|
+
"gridAutoFlow]___[value:dense",
|
|
12
|
+
"gap]___[value:xsmall",
|
|
13
|
+
"borderColor]___[value:stroke.subtle",
|
|
14
|
+
"maxHeight]___[value:135px",
|
|
15
|
+
"lineClamp]___[value:3",
|
|
16
|
+
"flexShrink]___[value:0",
|
|
17
|
+
"maxHeight]___[value:surface.xsmall",
|
|
18
|
+
"gap]___[value:xxsmall",
|
|
19
|
+
"flexWrap]___[value:wrap",
|
|
20
|
+
"alignItems]___[value:center",
|
|
21
|
+
"gridColumn]___[value:1 / -1",
|
|
22
|
+
"borderColor]___[value:stroke.default",
|
|
23
|
+
"border]___[value:1px solid",
|
|
24
|
+
"borderRadius]___[value:xsmall",
|
|
25
|
+
"padding]___[value:small",
|
|
26
|
+
"overflow]___[value:hidden",
|
|
27
|
+
"justifyContent]___[value:space-between",
|
|
28
|
+
"gap]___[value:medium",
|
|
29
|
+
"flex]___[value:2",
|
|
30
|
+
"marginBlockEnd]___[value:medium"
|
|
31
|
+
],
|
|
32
|
+
"recipes": {}
|
|
33
|
+
}
|
|
34
|
+
}
|
package/dist/styles.css
ADDED
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
@layer utilities {
|
|
2
|
+
.d_flex {
|
|
3
|
+
display: flex;
|
|
4
|
+
}
|
|
5
|
+
|
|
6
|
+
.gap_small {
|
|
7
|
+
gap: var(--spacing-small);
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
.d_grid {
|
|
11
|
+
display: grid;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
.grid-g_xsmall {
|
|
15
|
+
grid-gap: var(--spacing-xsmall);
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
.gap_xsmall {
|
|
19
|
+
gap: var(--spacing-xsmall);
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
.max-h_135px {
|
|
23
|
+
max-height: 135px;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
.lc_3 {
|
|
27
|
+
overflow: hidden;
|
|
28
|
+
display: -webkit-box;
|
|
29
|
+
-webkit-line-clamp: 3;
|
|
30
|
+
-webkit-box-orient: vertical;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
.max-h_surface\.xsmall {
|
|
34
|
+
max-height: var(--sizes-surface-xsmall);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
.gap_xxsmall {
|
|
38
|
+
gap: var(--spacing-xxsmall);
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
.grid-c_1_\/_-1 {
|
|
42
|
+
grid-column: 1 / -1;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
.bd_1px_solid {
|
|
46
|
+
border: 1px solid;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
.bdr_xsmall {
|
|
50
|
+
border-radius: var(--radii-xsmall);
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
.p_small {
|
|
54
|
+
padding: var(--spacing-small);
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
.ov_hidden {
|
|
58
|
+
overflow: hidden;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
.gap_medium {
|
|
62
|
+
gap: var(--spacing-medium);
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
.flex_2 {
|
|
66
|
+
flex: 2;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
.mbe_medium {
|
|
70
|
+
margin-block-end: var(--spacing-medium);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
.flex-d_column {
|
|
74
|
+
flex-direction: column;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
.grid-tc_repeat\(auto-fit\,_minmax\(200px\,_1fr\)\) {
|
|
78
|
+
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
.grid-af_dense {
|
|
82
|
+
grid-auto-flow: dense;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
.bd-c_stroke\.subtle {
|
|
86
|
+
border-color: var(--colors-stroke-subtle);
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
.flex-sh_0 {
|
|
90
|
+
flex-shrink: 0;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
.flex-wrap_wrap {
|
|
94
|
+
flex-wrap: wrap;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
.ai_center {
|
|
98
|
+
align-items: center;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
.bd-c_stroke\.default {
|
|
102
|
+
border-color: var(--colors-stroke-default);
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
.jc_space-between {
|
|
106
|
+
justify-content: space-between;
|
|
107
|
+
}
|
|
108
|
+
}
|
package/es/ImageMeta.js
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
import _styled from "@emotion/styled/base";
|
|
2
|
-
function _EMOTION_STRINGIFIED_CSS_ERROR__() { return "You have tried to stringify object returned from `css` function. It isn't supposed to be used directly (e.g. as value of the `className` prop), but rather handed to emotion so it can handle it (e.g. as value of `css` prop)."; }
|
|
3
1
|
/**
|
|
4
2
|
* Copyright (c) 2022-present, NDLA.
|
|
5
3
|
*
|
|
@@ -9,24 +7,8 @@ function _EMOTION_STRINGIFIED_CSS_ERROR__() { return "You have tried to stringif
|
|
|
9
7
|
*/
|
|
10
8
|
|
|
11
9
|
import prettyBytes from "pretty-bytes";
|
|
12
|
-
import {
|
|
13
|
-
import { jsx as _jsx } from "
|
|
14
|
-
const StyledDiv = /*#__PURE__*/_styled("div", {
|
|
15
|
-
target: "e171zbc01",
|
|
16
|
-
label: "StyledDiv"
|
|
17
|
-
})(fonts.sizes("16px", 1.3), ";" + (process.env.NODE_ENV === "production" ? "" : "/*# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIkltYWdlTWV0YS50c3giXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBYTRCIiwiZmlsZSI6IkltYWdlTWV0YS50c3giLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIENvcHlyaWdodCAoYykgMjAyMi1wcmVzZW50LCBORExBLlxuICpcbiAqIFRoaXMgc291cmNlIGNvZGUgaXMgbGljZW5zZWQgdW5kZXIgdGhlIEdQTHYzIGxpY2Vuc2UgZm91bmQgaW4gdGhlXG4gKiBMSUNFTlNFIGZpbGUgaW4gdGhlIHJvb3QgZGlyZWN0b3J5IG9mIHRoaXMgc291cmNlIHRyZWUuXG4gKlxuICovXG5cbmltcG9ydCBwcmV0dHlCeXRlcyBmcm9tIFwicHJldHR5LWJ5dGVzXCI7XG5pbXBvcnQgc3R5bGVkIGZyb20gXCJAZW1vdGlvbi9zdHlsZWRcIjtcbmltcG9ydCB7IGZvbnRzIH0gZnJvbSBcIkBuZGxhL2NvcmVcIjtcbmltcG9ydCB7IElJbWFnZURpbWVuc2lvbnMgfSBmcm9tIFwiQG5kbGEvdHlwZXMtYmFja2VuZC9pbWFnZS1hcGlcIjtcblxuY29uc3QgU3R5bGVkRGl2ID0gc3R5bGVkLmRpdmBcbiAgJHtmb250cy5zaXplcyhcIjE2cHhcIiwgMS4zKX1cbmA7XG5cbmNvbnN0IFN0eWxlZFNwYW4gPSBzdHlsZWQuc3BhbmBcbiAgdGV4dC1hbGlnbjogY2VudGVyO1xuYDtcblxuaW50ZXJmYWNlIFByb3BzIHtcbiAgY29udGVudFR5cGU6IHN0cmluZztcbiAgZmlsZVNpemU6IG51bWJlcjtcbiAgaW1hZ2VEaW1lbnNpb25zPzogSUltYWdlRGltZW5zaW9ucztcbn1cblxuY29uc3QgSW1hZ2VNZXRhID0gKHsgY29udGVudFR5cGUsIGZpbGVTaXplLCBpbWFnZURpbWVuc2lvbnMgfTogUHJvcHMpID0+IHtcbiAgY29uc3QgZGltZW5zaW9ucyA9IGltYWdlRGltZW5zaW9ucyA/IGAgLSAke2ltYWdlRGltZW5zaW9ucy53aWR0aH14JHtpbWFnZURpbWVuc2lvbnMuaGVpZ2h0fSBweGAgOiBcIlwiO1xuICByZXR1cm4gKFxuICAgIDxTdHlsZWREaXY+XG4gICAgICA8U3R5bGVkU3Bhbj57YCR7Y29udGVudFR5cGV9IC0gJHtwcmV0dHlCeXRlcyhmaWxlU2l6ZSl9JHtkaW1lbnNpb25zfWB9PC9TdHlsZWRTcGFuPlxuICAgIDwvU3R5bGVkRGl2PlxuICApO1xufTtcblxuZXhwb3J0IGRlZmF1bHQgSW1hZ2VNZXRhO1xuIl19 */"));
|
|
18
|
-
const StyledSpan = /*#__PURE__*/_styled("span", {
|
|
19
|
-
target: "e171zbc00",
|
|
20
|
-
label: "StyledSpan"
|
|
21
|
-
})(process.env.NODE_ENV === "production" ? {
|
|
22
|
-
name: "1azakc",
|
|
23
|
-
styles: "text-align:center"
|
|
24
|
-
} : {
|
|
25
|
-
name: "1azakc",
|
|
26
|
-
styles: "text-align:center",
|
|
27
|
-
map: "/*# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIkltYWdlTWV0YS50c3giXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBaUI4QiIsImZpbGUiOiJJbWFnZU1ldGEudHN4Iiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBDb3B5cmlnaHQgKGMpIDIwMjItcHJlc2VudCwgTkRMQS5cbiAqXG4gKiBUaGlzIHNvdXJjZSBjb2RlIGlzIGxpY2Vuc2VkIHVuZGVyIHRoZSBHUEx2MyBsaWNlbnNlIGZvdW5kIGluIHRoZVxuICogTElDRU5TRSBmaWxlIGluIHRoZSByb290IGRpcmVjdG9yeSBvZiB0aGlzIHNvdXJjZSB0cmVlLlxuICpcbiAqL1xuXG5pbXBvcnQgcHJldHR5Qnl0ZXMgZnJvbSBcInByZXR0eS1ieXRlc1wiO1xuaW1wb3J0IHN0eWxlZCBmcm9tIFwiQGVtb3Rpb24vc3R5bGVkXCI7XG5pbXBvcnQgeyBmb250cyB9IGZyb20gXCJAbmRsYS9jb3JlXCI7XG5pbXBvcnQgeyBJSW1hZ2VEaW1lbnNpb25zIH0gZnJvbSBcIkBuZGxhL3R5cGVzLWJhY2tlbmQvaW1hZ2UtYXBpXCI7XG5cbmNvbnN0IFN0eWxlZERpdiA9IHN0eWxlZC5kaXZgXG4gICR7Zm9udHMuc2l6ZXMoXCIxNnB4XCIsIDEuMyl9XG5gO1xuXG5jb25zdCBTdHlsZWRTcGFuID0gc3R5bGVkLnNwYW5gXG4gIHRleHQtYWxpZ246IGNlbnRlcjtcbmA7XG5cbmludGVyZmFjZSBQcm9wcyB7XG4gIGNvbnRlbnRUeXBlOiBzdHJpbmc7XG4gIGZpbGVTaXplOiBudW1iZXI7XG4gIGltYWdlRGltZW5zaW9ucz86IElJbWFnZURpbWVuc2lvbnM7XG59XG5cbmNvbnN0IEltYWdlTWV0YSA9ICh7IGNvbnRlbnRUeXBlLCBmaWxlU2l6ZSwgaW1hZ2VEaW1lbnNpb25zIH06IFByb3BzKSA9PiB7XG4gIGNvbnN0IGRpbWVuc2lvbnMgPSBpbWFnZURpbWVuc2lvbnMgPyBgIC0gJHtpbWFnZURpbWVuc2lvbnMud2lkdGh9eCR7aW1hZ2VEaW1lbnNpb25zLmhlaWdodH0gcHhgIDogXCJcIjtcbiAgcmV0dXJuIChcbiAgICA8U3R5bGVkRGl2PlxuICAgICAgPFN0eWxlZFNwYW4+e2Ake2NvbnRlbnRUeXBlfSAtICR7cHJldHR5Qnl0ZXMoZmlsZVNpemUpfSR7ZGltZW5zaW9uc31gfTwvU3R5bGVkU3Bhbj5cbiAgICA8L1N0eWxlZERpdj5cbiAgKTtcbn07XG5cbmV4cG9ydCBkZWZhdWx0IEltYWdlTWV0YTtcbiJdfQ== */",
|
|
28
|
-
toString: _EMOTION_STRINGIFIED_CSS_ERROR__
|
|
29
|
-
});
|
|
10
|
+
import { Text } from "@ndla/primitives";
|
|
11
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
30
12
|
const ImageMeta = _ref => {
|
|
31
13
|
let {
|
|
32
14
|
contentType,
|
|
@@ -34,10 +16,8 @@ const ImageMeta = _ref => {
|
|
|
34
16
|
imageDimensions
|
|
35
17
|
} = _ref;
|
|
36
18
|
const dimensions = imageDimensions ? ` - ${imageDimensions.width}x${imageDimensions.height} px` : "";
|
|
37
|
-
return _jsx(
|
|
38
|
-
children:
|
|
39
|
-
children: `${contentType} - ${prettyBytes(fileSize)}${dimensions}`
|
|
40
|
-
})
|
|
19
|
+
return /*#__PURE__*/_jsx(Text, {
|
|
20
|
+
children: `${contentType} - ${prettyBytes(fileSize)}${dimensions}`
|
|
41
21
|
});
|
|
42
22
|
};
|
|
43
23
|
export default ImageMeta;
|