@madebywild/sanity-icon-field 0.3.19 → 1.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/LICENSE +21 -0
- package/README.md +42 -0
- package/dist/index.cjs +5 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +14 -1
- package/dist/index.d.ts +14 -1
- package/dist/index.js +5 -3
- package/dist/index.js.map +1 -1
- package/package.json +8 -8
- package/src/index.tsx +2 -2
- package/src/input.tsx +12 -6
- package/src/types.tsx +2 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Made by Wild
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1 +1,43 @@
|
|
|
1
|
+
> [!IMPORTANT]
|
|
2
|
+
> This package is primarily intended for internal use.
|
|
3
|
+
|
|
1
4
|
# @madebywild/sanity-icon-field
|
|
5
|
+
|
|
6
|
+
Sanity field type for selecting icons from a predefined list.
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pnpm add @madebywild/sanity-icon-field
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Configure Plugin
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { wildSanityIconFieldPlugin } from "@madebywild/sanity-icon-field";
|
|
19
|
+
|
|
20
|
+
export default defineConfig({
|
|
21
|
+
plugins: [
|
|
22
|
+
wildSanityIconFieldPlugin({
|
|
23
|
+
iconList: [
|
|
24
|
+
{ label: "Arrow Right", value: "arrow-right" },
|
|
25
|
+
{ label: "Play", value: "play" },
|
|
26
|
+
],
|
|
27
|
+
}),
|
|
28
|
+
],
|
|
29
|
+
});
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Use in Schema
|
|
33
|
+
|
|
34
|
+
```ts
|
|
35
|
+
defineField({
|
|
36
|
+
name: "ctaIcon",
|
|
37
|
+
type: "wild.icon",
|
|
38
|
+
options: {
|
|
39
|
+
// Per-field subset of the plugin's global `iconList`.
|
|
40
|
+
whitelist: ["arrow-right", "play"],
|
|
41
|
+
},
|
|
42
|
+
});
|
|
43
|
+
```
|
package/dist/index.cjs
CHANGED
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: !0 });
|
|
3
3
|
var jsxRuntime = require("react/jsx-runtime"), sanity = require("sanity"), compilerRuntime = require("react/compiler-runtime"), asyncAutocomplete = require("@madebywild/sanity-utils/async-autocomplete"), ui = require("@sanity/ui");
|
|
4
4
|
function defaultRenderSelected(value) {
|
|
5
|
-
return /* @__PURE__ */ jsxRuntime.jsx(ui.Text, { size: 2, children: value });
|
|
5
|
+
return typeof value == "string" ? /* @__PURE__ */ jsxRuntime.jsx(ui.Text, { size: 2, children: value }) : value;
|
|
6
6
|
}
|
|
7
7
|
function defaultRenderOption({
|
|
8
8
|
label,
|
|
9
9
|
value
|
|
10
10
|
}) {
|
|
11
11
|
return /* @__PURE__ */ jsxRuntime.jsx(ui.Card, { as: "button", children: /* @__PURE__ */ jsxRuntime.jsxs(ui.Flex, { align: "center", padding: 2, children: [
|
|
12
|
-
/* @__PURE__ */ jsxRuntime.jsx("span", { children: "\u{1F9FF}" }),
|
|
13
|
-
/* @__PURE__ */ jsxRuntime.jsx(ui.Box, { flex: 1, padding: 2, children: /* @__PURE__ */ jsxRuntime.jsx(ui.Text, { size: 2, children: label ?? value })
|
|
12
|
+
typeof value == "string" ? /* @__PURE__ */ jsxRuntime.jsx("span", { children: "\u{1F9FF}" }) : value,
|
|
13
|
+
/* @__PURE__ */ jsxRuntime.jsx(ui.Box, { flex: 1, padding: 2, children: typeof label == "string" ? /* @__PURE__ */ jsxRuntime.jsx(ui.Text, { size: 2, children: label }) : label ?? value })
|
|
14
14
|
] }) });
|
|
15
15
|
}
|
|
16
16
|
function IconInput(t0) {
|
|
@@ -60,6 +60,8 @@ const typeName = "wild.icon", wildSanityIconFieldPlugin = sanity.definePlugin((c
|
|
|
60
60
|
})]
|
|
61
61
|
}
|
|
62
62
|
}));
|
|
63
|
+
exports.defaultRenderOption = defaultRenderOption;
|
|
64
|
+
exports.defaultRenderSelected = defaultRenderSelected;
|
|
63
65
|
exports.typeName = typeName;
|
|
64
66
|
exports.wildSanityIconFieldPlugin = wildSanityIconFieldPlugin;
|
|
65
67
|
//# sourceMappingURL=index.cjs.map
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","sources":["../src/input.tsx","../src/types.tsx","../src/index.tsx"],"sourcesContent":["import { AsyncAutocomplete } from \"@madebywild/sanity-utils/async-autocomplete\";\nimport { Box, Card, Flex, Text } from \"@sanity/ui\";\nimport { type StringInputProps, set, unset } from \"sanity\";\nimport type { FieldOptions, PluginConfig } from \"./types\";\n\nfunction defaultRenderSelected(value: string) {\n return <Text size={2}>{value}</Text>;\n}\n\nfunction defaultRenderOption({ label, value }: { label?: string; value: string }) {\n return (\n <Card as=\"button\">\n <Flex align=\"center\" padding={2}>\n
|
|
1
|
+
{"version":3,"file":"index.cjs","sources":["../src/input.tsx","../src/types.tsx","../src/index.tsx"],"sourcesContent":["import { AsyncAutocomplete } from \"@madebywild/sanity-utils/async-autocomplete\";\nimport { Box, Card, Flex, Text } from \"@sanity/ui\";\nimport { type StringInputProps, set, unset } from \"sanity\";\nimport type { FieldOptions, PluginConfig } from \"./types\";\n\n/** @public */\nfunction defaultRenderSelected(value: React.JSX.Element | string) {\n if (typeof value === \"string\") return <Text size={2}>{value}</Text>;\n return value;\n}\n\n/** @public */\nfunction defaultRenderOption({ label, value }: { label?: React.JSX.Element | string; value: React.JSX.Element | string }) {\n const Icon = typeof value === \"string\" ? <span>🧿</span> : value;\n const Label = typeof label === \"string\" ? <Text size={2}>{label}</Text> : (label ?? value);\n\n return (\n <Card as=\"button\">\n <Flex align=\"center\" padding={2}>\n {Icon}\n <Box flex={1} padding={2}>\n {Label}\n </Box>\n </Flex>\n </Card>\n );\n}\n\nfunction IconInput({\n pluginConfig,\n ...props\n}: StringInputProps & {\n pluginConfig: PluginConfig;\n}) {\n const options = props.schemaType.options as FieldOptions | undefined;\n const iconList = pluginConfig.iconList;\n const renderOption = pluginConfig.renderOption ?? defaultRenderOption;\n const renderSelected = pluginConfig.renderSelected ?? defaultRenderSelected;\n\n const whitelist = options?.whitelist;\n const blacklist = options?.blacklist;\n\n return (\n <AsyncAutocomplete\n placeholder=\"Select icon\"\n noOptionsPlaceholder=\"No icons found\"\n listItems={iconList}\n whitelist={whitelist}\n blacklist={blacklist}\n value={props.value}\n renderValue={(value, opt) => opt?.label ?? value}\n onChange={(value) => {\n const next = value ? set(value) : unset();\n return props.onChange(next);\n }}\n renderSelected={(value) => {\n return renderSelected(value);\n }}\n renderOption={({ label, value }) => {\n return renderOption({ label, value });\n }}\n />\n );\n}\n\nexport { IconInput, defaultRenderSelected, defaultRenderOption };\n","import type { ListItems } from \"@madebywild/sanity-utils/async-autocomplete\";\nimport type { ObjectOptions, StringDefinition } from \"sanity\";\n\n/** @public */\nexport const typeName = \"wild.icon\" as const;\n\n/** @public */\nexport type PluginConfig = {\n /**\n * A list of icons to show in the icon picker.\n * @example\n * ```ts\n * iconList: [\n * { label: \"X\", value: \"x\" },\n * { label: \"Check\", value: \"check\" },\n * ]\n * ```\n */\n iconList: ListItems;\n /**\n * A function to render the selected icon value.\n * Note: Import `defaultRenderSelected` to use the default rendering.\n * @example\n * ```ts\n * renderSelected: (value) => <svg><use href={`#icon-${value}`} /></svg>\n * ```\n */\n renderSelected?: (value: string) => React.JSX.Element;\n /** A function to render each icon option in the dropdown.\n * Note: Import `defaultRenderOption` to use the default rendering.\n * @example\n * ```ts\n * renderOption: (item) => <div>{item.label}</div>\n * ```\n */\n renderOption?: (item: { label?: string; value: string }) => React.JSX.Element;\n};\n\n/** @public */\nexport type FieldOptions = ObjectOptions & {\n /**\n * Whitelist icons by their values.\n */\n whitelist?: string[];\n /**\n * Blacklist icons by their values.\n */\n blacklist?: string[];\n};\n\n// Add the custom field definition to Sanity's intrinsic definitions\n// so that type checking works correctly when using this field type.\ndeclare module \"sanity\" {\n export interface IntrinsicDefinitions {\n [typeName]: Omit<StringDefinition, \"type\" | \"fields\" | \"options\" | \"components\"> & {\n type: typeof typeName;\n options?: FieldOptions;\n };\n }\n}\n","import { definePlugin, defineType } from \"sanity\";\nimport { defaultRenderOption, defaultRenderSelected, IconInput } from \"./input\";\nimport { type FieldOptions, type PluginConfig, typeName } from \"./types\";\n\n/** @public */\nconst wildSanityIconFieldPlugin = definePlugin<PluginConfig>((config) => {\n return {\n name: \"@madebywild/sanity-icon-field\",\n schema: {\n types: [\n defineType({\n name: typeName,\n type: \"string\",\n title: \"Icon\",\n description: \"Select an icon.\",\n icon: () => <>🧿</>,\n components: {\n input: (props) => <IconInput pluginConfig={config} {...props} />,\n },\n }),\n ],\n },\n };\n});\n\nexport { wildSanityIconFieldPlugin, typeName, defaultRenderOption, defaultRenderSelected, type PluginConfig, type FieldOptions };\n"],"names":["defaultRenderSelected","value","jsx","Text","defaultRenderOption","label","Card","Flex","Icon","Box","Label","IconInput","t0","$","_c","pluginConfig","props","options","schemaType","iconList","renderOption","renderSelected","whitelist","blacklist","t1","value_0","next","set","unset","onChange","t2","value_1","t3","t4","value_2","AsyncAutocomplete","_temp","opt","typeName","wildSanityIconFieldPlugin","definePlugin","config","name","schema","types","defineType","type","title","description","icon","Fragment","components","input"],"mappings":";;;AAMA,SAASA,sBAAsBC,OAAmC;AAChE,SAAI,OAAOA,SAAU,WAAiBC,2BAAAA,IAACC,GAAAA,QAAK,MAAM,GAAIF,iBAAM,IACrDA;AACT;AAGA,SAASG,oBAAoB;AAAA,EAAEC;AAAAA,EAAOJ;AAAiF,GAAG;AAIxH,SACEC,2BAAAA,IAACI,GAAAA,QAAK,IAAG,UACP,0CAACC,GAAAA,MAAA,EAAK,OAAM,UAAS,SAAS,GAC3BC,UAAAA;AAAAA,IANM,OAAOP,SAAU,WAAWC,+BAAC,QAAA,EAAK,uBAAE,IAAUD;AAAAA,mCAOpDQ,GAAAA,KAAA,EAAI,MAAM,GAAG,SAAS,GACpBC,UAPK,OAAOL,SAAU,0CAAYF,GAAAA,MAAA,EAAK,MAAM,GAAIE,UAAAA,MAAAA,CAAM,IAAWA,SAASJ,MAAAA,CAQ9E;AAAA,EAAA,EAAA,CACF,EAAA,CACF;AAEJ;AAEA,SAAAU,UAAAC,IAAA;AAAA,QAAAC,IAAAC,gBAAAA,EAAA,EAAA;AAAA,MAAAC,cAAAC;AAAAH,WAAAD,MAAmB;AAAA,IAAAG;AAAAA,IAAA,GAAAC;AAAAA,EAAAA,IAAAJ,IAKlBC,OAAAD,IAAAC,OAAAE,cAAAF,OAAAG,UAAAD,eAAAF,EAAA,CAAA,GAAAG,QAAAH,EAAA,CAAA;AACC,QAAAI,UAAgBD,MAAKE,WAAWD,SAChCE,WAAiBJ,aAAYI,UAC7BC,eAAqBL,aAAYK,gBAAZhB,qBACrBiB,iBAAuBN,aAAYM,kBAAZrB,uBAEvBsB,YAAkBL,SAAOK,WACzBC,YAAkBN,SAAOM;AAAY,MAAAC;AAAAX,WAAAG,SAWvBQ,KAAAC,CAAAA,YAAA;AACR,UAAAC,OAAazB,UAAQ0B,OAAAA,IAAI1B,OAAe,IAAN2B,OAAAA,MAAAA;AAAQ,WACnCZ,MAAKa,SAAUH,IAAI;AAAA,EAAC,GAC5Bb,OAAAG,OAAAH,OAAAW,MAAAA,KAAAX,EAAA,CAAA;AAAA,MAAAiB;AAAAjB,WAAAQ,kBACeS,KAAAC,CAAAA,YACPV,eAAepB,OAAK,GAC5BY,OAAAQ,gBAAAR,OAAAiB,MAAAA,KAAAjB,EAAA,CAAA;AAAA,MAAAmB;AAAAnB,WAAAO,gBACaY,KAAAC,CAAAA,QAAA;AAAC,UAAA;AAAA,MAAA5B;AAAAA,MAAAJ,OAAAiC;AAAAA,IAAAA,IAAAD;AAAgB,WACtBb,aAAa;AAAA,MAAAf;AAAAA,MAAAJ,OAASA;AAAAA,IAAAA,CAAO;AAAA,EAAC,GACtCY,OAAAO,cAAAP,OAAAmB,MAAAA,KAAAnB,EAAA,CAAA;AAAA,MAAAoB;AAAA,SAAApB,EAAA,CAAA,MAAAU,aAAAV,EAAA,EAAA,MAAAM,YAAAN,EAAA,EAAA,MAAAG,MAAAf,SAAAY,EAAA,EAAA,MAAAW,MAAAX,EAAA,EAAA,MAAAiB,MAAAjB,EAAA,EAAA,MAAAmB,MAAAnB,EAAA,EAAA,MAAAS,aAjBHW,KAAA/B,2BAAAA,IAACiC,kBAAAA,mBAAA,EACa,aAAA,eACS,sBAAA,kBACVhB,qBACAG,WACAC,WACJ,OAAAP,MAAKf,OACC,aAAAmC,OACH,UAAAZ,IAIM,gBAAAM,IAGF,cAAAE,GAAAA,CAEb,GACDnB,OAAAU,WAAAV,QAAAM,UAAAN,EAAA,EAAA,IAAAG,MAAAf,OAAAY,QAAAW,IAAAX,QAAAiB,IAAAjB,QAAAmB,IAAAnB,QAAAS,WAAAT,QAAAoB,MAAAA,KAAApB,EAAA,EAAA,GAlBFoB;AAkBE;AAjCN,SAAAG,MAAAnC,OAAAoC,KAAA;AAAA,SAsBmCA,KAAGhC,SAAHJ;AAAmB;AC9C/C,MAAMqC,WAAW,aCClBC,4BAA4BC,OAAAA,aAA4BC,CAAAA,YACrD;AAAA,EACLC,MAAM;AAAA,EACNC,QAAQ;AAAA,IACNC,OAAO,CACLC,OAAAA,WAAW;AAAA,MACTH,MAAMJ;AAAAA,MACNQ,MAAM;AAAA,MACNC,OAAO;AAAA,MACPC,aAAa;AAAA,MACbC,MAAMA,MAAM/C,2BAAAA,IAAAgD,WAAAA,UAAA,EAAE,UAAA,YAAA,CAAE;AAAA,MAChBC,YAAY;AAAA,QACVC,OAAQpC,CAAAA,UAAUd,+BAAC,aAAU,cAAcuC,QAAQ,GAAIzB,MAAAA,CAAM;AAAA,MAAA;AAAA,IAC/D,CACD,CAAC;AAAA,EAAA;AAGR,EACD;;;;;"}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import * as sanity0 from "sanity";
|
|
2
2
|
import { ObjectOptions, StringDefinition } from "sanity";
|
|
3
|
+
import * as react2 from "react";
|
|
3
4
|
/** @public */
|
|
4
5
|
type ListItem = {
|
|
5
6
|
value: string;
|
|
@@ -25,6 +26,7 @@ type PluginConfig = {
|
|
|
25
26
|
iconList: ListItems;
|
|
26
27
|
/**
|
|
27
28
|
* A function to render the selected icon value.
|
|
29
|
+
* Note: Import `defaultRenderSelected` to use the default rendering.
|
|
28
30
|
* @example
|
|
29
31
|
* ```ts
|
|
30
32
|
* renderSelected: (value) => <svg><use href={`#icon-${value}`} /></svg>
|
|
@@ -32,6 +34,7 @@ type PluginConfig = {
|
|
|
32
34
|
*/
|
|
33
35
|
renderSelected?: (value: string) => React.JSX.Element;
|
|
34
36
|
/** A function to render each icon option in the dropdown.
|
|
37
|
+
* Note: Import `defaultRenderOption` to use the default rendering.
|
|
35
38
|
* @example
|
|
36
39
|
* ```ts
|
|
37
40
|
* renderOption: (item) => <div>{item.label}</div>
|
|
@@ -62,5 +65,15 @@ declare module "sanity" {
|
|
|
62
65
|
}
|
|
63
66
|
}
|
|
64
67
|
/** @public */
|
|
68
|
+
declare function defaultRenderSelected(value: React.JSX.Element | string): react2.JSX.Element;
|
|
69
|
+
/** @public */
|
|
70
|
+
declare function defaultRenderOption({
|
|
71
|
+
label,
|
|
72
|
+
value
|
|
73
|
+
}: {
|
|
74
|
+
label?: React.JSX.Element | string;
|
|
75
|
+
value: React.JSX.Element | string;
|
|
76
|
+
}): react2.JSX.Element;
|
|
77
|
+
/** @public */
|
|
65
78
|
declare const wildSanityIconFieldPlugin: sanity0.Plugin<PluginConfig>;
|
|
66
|
-
export { type FieldOptions, type PluginConfig, typeName, wildSanityIconFieldPlugin };
|
|
79
|
+
export { type FieldOptions, type PluginConfig, defaultRenderOption, defaultRenderSelected, typeName, wildSanityIconFieldPlugin };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import * as sanity0 from "sanity";
|
|
2
2
|
import { ObjectOptions, StringDefinition } from "sanity";
|
|
3
|
+
import * as react2 from "react";
|
|
3
4
|
/** @public */
|
|
4
5
|
type ListItem = {
|
|
5
6
|
value: string;
|
|
@@ -25,6 +26,7 @@ type PluginConfig = {
|
|
|
25
26
|
iconList: ListItems;
|
|
26
27
|
/**
|
|
27
28
|
* A function to render the selected icon value.
|
|
29
|
+
* Note: Import `defaultRenderSelected` to use the default rendering.
|
|
28
30
|
* @example
|
|
29
31
|
* ```ts
|
|
30
32
|
* renderSelected: (value) => <svg><use href={`#icon-${value}`} /></svg>
|
|
@@ -32,6 +34,7 @@ type PluginConfig = {
|
|
|
32
34
|
*/
|
|
33
35
|
renderSelected?: (value: string) => React.JSX.Element;
|
|
34
36
|
/** A function to render each icon option in the dropdown.
|
|
37
|
+
* Note: Import `defaultRenderOption` to use the default rendering.
|
|
35
38
|
* @example
|
|
36
39
|
* ```ts
|
|
37
40
|
* renderOption: (item) => <div>{item.label}</div>
|
|
@@ -62,5 +65,15 @@ declare module "sanity" {
|
|
|
62
65
|
}
|
|
63
66
|
}
|
|
64
67
|
/** @public */
|
|
68
|
+
declare function defaultRenderSelected(value: React.JSX.Element | string): react2.JSX.Element;
|
|
69
|
+
/** @public */
|
|
70
|
+
declare function defaultRenderOption({
|
|
71
|
+
label,
|
|
72
|
+
value
|
|
73
|
+
}: {
|
|
74
|
+
label?: React.JSX.Element | string;
|
|
75
|
+
value: React.JSX.Element | string;
|
|
76
|
+
}): react2.JSX.Element;
|
|
77
|
+
/** @public */
|
|
65
78
|
declare const wildSanityIconFieldPlugin: sanity0.Plugin<PluginConfig>;
|
|
66
|
-
export { type FieldOptions, type PluginConfig, typeName, wildSanityIconFieldPlugin };
|
|
79
|
+
export { type FieldOptions, type PluginConfig, defaultRenderOption, defaultRenderSelected, typeName, wildSanityIconFieldPlugin };
|
package/dist/index.js
CHANGED
|
@@ -4,15 +4,15 @@ import { c } from "react/compiler-runtime";
|
|
|
4
4
|
import { AsyncAutocomplete } from "@madebywild/sanity-utils/async-autocomplete";
|
|
5
5
|
import { Text, Card, Flex, Box } from "@sanity/ui";
|
|
6
6
|
function defaultRenderSelected(value) {
|
|
7
|
-
return /* @__PURE__ */ jsx(Text, { size: 2, children: value });
|
|
7
|
+
return typeof value == "string" ? /* @__PURE__ */ jsx(Text, { size: 2, children: value }) : value;
|
|
8
8
|
}
|
|
9
9
|
function defaultRenderOption({
|
|
10
10
|
label,
|
|
11
11
|
value
|
|
12
12
|
}) {
|
|
13
13
|
return /* @__PURE__ */ jsx(Card, { as: "button", children: /* @__PURE__ */ jsxs(Flex, { align: "center", padding: 2, children: [
|
|
14
|
-
/* @__PURE__ */ jsx("span", { children: "\u{1F9FF}" }),
|
|
15
|
-
/* @__PURE__ */ jsx(Box, { flex: 1, padding: 2, children: /* @__PURE__ */ jsx(Text, { size: 2, children: label ?? value })
|
|
14
|
+
typeof value == "string" ? /* @__PURE__ */ jsx("span", { children: "\u{1F9FF}" }) : value,
|
|
15
|
+
/* @__PURE__ */ jsx(Box, { flex: 1, padding: 2, children: typeof label == "string" ? /* @__PURE__ */ jsx(Text, { size: 2, children: label }) : label ?? value })
|
|
16
16
|
] }) });
|
|
17
17
|
}
|
|
18
18
|
function IconInput(t0) {
|
|
@@ -63,6 +63,8 @@ const typeName = "wild.icon", wildSanityIconFieldPlugin = definePlugin((config)
|
|
|
63
63
|
}
|
|
64
64
|
}));
|
|
65
65
|
export {
|
|
66
|
+
defaultRenderOption,
|
|
67
|
+
defaultRenderSelected,
|
|
66
68
|
typeName,
|
|
67
69
|
wildSanityIconFieldPlugin
|
|
68
70
|
};
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":["../src/input.tsx","../src/types.tsx","../src/index.tsx"],"sourcesContent":["import { AsyncAutocomplete } from \"@madebywild/sanity-utils/async-autocomplete\";\nimport { Box, Card, Flex, Text } from \"@sanity/ui\";\nimport { type StringInputProps, set, unset } from \"sanity\";\nimport type { FieldOptions, PluginConfig } from \"./types\";\n\nfunction defaultRenderSelected(value: string) {\n return <Text size={2}>{value}</Text>;\n}\n\nfunction defaultRenderOption({ label, value }: { label?: string; value: string }) {\n return (\n <Card as=\"button\">\n <Flex align=\"center\" padding={2}>\n
|
|
1
|
+
{"version":3,"file":"index.js","sources":["../src/input.tsx","../src/types.tsx","../src/index.tsx"],"sourcesContent":["import { AsyncAutocomplete } from \"@madebywild/sanity-utils/async-autocomplete\";\nimport { Box, Card, Flex, Text } from \"@sanity/ui\";\nimport { type StringInputProps, set, unset } from \"sanity\";\nimport type { FieldOptions, PluginConfig } from \"./types\";\n\n/** @public */\nfunction defaultRenderSelected(value: React.JSX.Element | string) {\n if (typeof value === \"string\") return <Text size={2}>{value}</Text>;\n return value;\n}\n\n/** @public */\nfunction defaultRenderOption({ label, value }: { label?: React.JSX.Element | string; value: React.JSX.Element | string }) {\n const Icon = typeof value === \"string\" ? <span>🧿</span> : value;\n const Label = typeof label === \"string\" ? <Text size={2}>{label}</Text> : (label ?? value);\n\n return (\n <Card as=\"button\">\n <Flex align=\"center\" padding={2}>\n {Icon}\n <Box flex={1} padding={2}>\n {Label}\n </Box>\n </Flex>\n </Card>\n );\n}\n\nfunction IconInput({\n pluginConfig,\n ...props\n}: StringInputProps & {\n pluginConfig: PluginConfig;\n}) {\n const options = props.schemaType.options as FieldOptions | undefined;\n const iconList = pluginConfig.iconList;\n const renderOption = pluginConfig.renderOption ?? defaultRenderOption;\n const renderSelected = pluginConfig.renderSelected ?? defaultRenderSelected;\n\n const whitelist = options?.whitelist;\n const blacklist = options?.blacklist;\n\n return (\n <AsyncAutocomplete\n placeholder=\"Select icon\"\n noOptionsPlaceholder=\"No icons found\"\n listItems={iconList}\n whitelist={whitelist}\n blacklist={blacklist}\n value={props.value}\n renderValue={(value, opt) => opt?.label ?? value}\n onChange={(value) => {\n const next = value ? set(value) : unset();\n return props.onChange(next);\n }}\n renderSelected={(value) => {\n return renderSelected(value);\n }}\n renderOption={({ label, value }) => {\n return renderOption({ label, value });\n }}\n />\n );\n}\n\nexport { IconInput, defaultRenderSelected, defaultRenderOption };\n","import type { ListItems } from \"@madebywild/sanity-utils/async-autocomplete\";\nimport type { ObjectOptions, StringDefinition } from \"sanity\";\n\n/** @public */\nexport const typeName = \"wild.icon\" as const;\n\n/** @public */\nexport type PluginConfig = {\n /**\n * A list of icons to show in the icon picker.\n * @example\n * ```ts\n * iconList: [\n * { label: \"X\", value: \"x\" },\n * { label: \"Check\", value: \"check\" },\n * ]\n * ```\n */\n iconList: ListItems;\n /**\n * A function to render the selected icon value.\n * Note: Import `defaultRenderSelected` to use the default rendering.\n * @example\n * ```ts\n * renderSelected: (value) => <svg><use href={`#icon-${value}`} /></svg>\n * ```\n */\n renderSelected?: (value: string) => React.JSX.Element;\n /** A function to render each icon option in the dropdown.\n * Note: Import `defaultRenderOption` to use the default rendering.\n * @example\n * ```ts\n * renderOption: (item) => <div>{item.label}</div>\n * ```\n */\n renderOption?: (item: { label?: string; value: string }) => React.JSX.Element;\n};\n\n/** @public */\nexport type FieldOptions = ObjectOptions & {\n /**\n * Whitelist icons by their values.\n */\n whitelist?: string[];\n /**\n * Blacklist icons by their values.\n */\n blacklist?: string[];\n};\n\n// Add the custom field definition to Sanity's intrinsic definitions\n// so that type checking works correctly when using this field type.\ndeclare module \"sanity\" {\n export interface IntrinsicDefinitions {\n [typeName]: Omit<StringDefinition, \"type\" | \"fields\" | \"options\" | \"components\"> & {\n type: typeof typeName;\n options?: FieldOptions;\n };\n }\n}\n","import { definePlugin, defineType } from \"sanity\";\nimport { defaultRenderOption, defaultRenderSelected, IconInput } from \"./input\";\nimport { type FieldOptions, type PluginConfig, typeName } from \"./types\";\n\n/** @public */\nconst wildSanityIconFieldPlugin = definePlugin<PluginConfig>((config) => {\n return {\n name: \"@madebywild/sanity-icon-field\",\n schema: {\n types: [\n defineType({\n name: typeName,\n type: \"string\",\n title: \"Icon\",\n description: \"Select an icon.\",\n icon: () => <>🧿</>,\n components: {\n input: (props) => <IconInput pluginConfig={config} {...props} />,\n },\n }),\n ],\n },\n };\n});\n\nexport { wildSanityIconFieldPlugin, typeName, defaultRenderOption, defaultRenderSelected, type PluginConfig, type FieldOptions };\n"],"names":["defaultRenderSelected","value","defaultRenderOption","label","Icon","Label","IconInput","t0","$","_c","pluginConfig","props","options","schemaType","iconList","renderOption","renderSelected","whitelist","blacklist","t1","value_0","next","set","unset","onChange","t2","value_1","t3","t4","value_2","_temp","opt","typeName","wildSanityIconFieldPlugin","definePlugin","config","name","schema","types","defineType","type","title","description","icon","components","input"],"mappings":";;;;;AAMA,SAASA,sBAAsBC,OAAmC;AAChE,SAAI,OAAOA,SAAU,WAAiB,oBAAC,QAAK,MAAM,GAAIA,iBAAM,IACrDA;AACT;AAGA,SAASC,oBAAoB;AAAA,EAAEC;AAAAA,EAAOF;AAAiF,GAAG;AAIxH,SACE,oBAAC,QAAK,IAAG,UACP,+BAAC,MAAA,EAAK,OAAM,UAAS,SAAS,GAC3BG,UAAAA;AAAAA,IANM,OAAOH,SAAU,WAAW,oBAAC,QAAA,EAAK,uBAAE,IAAUA;AAAAA,wBAOpD,KAAA,EAAI,MAAM,GAAG,SAAS,GACpBI,UAPK,OAAOF,SAAU,+BAAY,MAAA,EAAK,MAAM,GAAIA,UAAAA,MAAAA,CAAM,IAAWA,SAASF,MAAAA,CAQ9E;AAAA,EAAA,EAAA,CACF,EAAA,CACF;AAEJ;AAEA,SAAAK,UAAAC,IAAA;AAAA,QAAAC,IAAAC,EAAA,EAAA;AAAA,MAAAC,cAAAC;AAAAH,WAAAD,MAAmB;AAAA,IAAAG;AAAAA,IAAA,GAAAC;AAAAA,EAAAA,IAAAJ,IAKlBC,OAAAD,IAAAC,OAAAE,cAAAF,OAAAG,UAAAD,eAAAF,EAAA,CAAA,GAAAG,QAAAH,EAAA,CAAA;AACC,QAAAI,UAAgBD,MAAKE,WAAWD,SAChCE,WAAiBJ,aAAYI,UAC7BC,eAAqBL,aAAYK,gBAAZb,qBACrBc,iBAAuBN,aAAYM,kBAAZhB,uBAEvBiB,YAAkBL,SAAOK,WACzBC,YAAkBN,SAAOM;AAAY,MAAAC;AAAAX,WAAAG,SAWvBQ,KAAAC,CAAAA,YAAA;AACR,UAAAC,OAAapB,UAAQqB,IAAIrB,OAAe,IAANsB,MAAAA;AAAQ,WACnCZ,MAAKa,SAAUH,IAAI;AAAA,EAAC,GAC5Bb,OAAAG,OAAAH,OAAAW,MAAAA,KAAAX,EAAA,CAAA;AAAA,MAAAiB;AAAAjB,WAAAQ,kBACeS,KAAAC,CAAAA,YACPV,eAAef,OAAK,GAC5BO,OAAAQ,gBAAAR,OAAAiB,MAAAA,KAAAjB,EAAA,CAAA;AAAA,MAAAmB;AAAAnB,WAAAO,gBACaY,KAAAC,CAAAA,QAAA;AAAC,UAAA;AAAA,MAAAzB;AAAAA,MAAAF,OAAA4B;AAAAA,IAAAA,IAAAD;AAAgB,WACtBb,aAAa;AAAA,MAAAZ;AAAAA,MAAAF,OAASA;AAAAA,IAAAA,CAAO;AAAA,EAAC,GACtCO,OAAAO,cAAAP,OAAAmB,MAAAA,KAAAnB,EAAA,CAAA;AAAA,MAAAoB;AAAA,SAAApB,EAAA,CAAA,MAAAU,aAAAV,EAAA,EAAA,MAAAM,YAAAN,EAAA,EAAA,MAAAG,MAAAV,SAAAO,EAAA,EAAA,MAAAW,MAAAX,EAAA,EAAA,MAAAiB,MAAAjB,EAAA,EAAA,MAAAmB,MAAAnB,EAAA,EAAA,MAAAS,aAjBHW,KAAA,oBAAC,mBAAA,EACa,aAAA,eACS,sBAAA,kBACVd,qBACAG,WACAC,WACJ,OAAAP,MAAKV,OACC,aAAA6B,OACH,UAAAX,IAIM,gBAAAM,IAGF,cAAAE,GAAAA,CAEb,GACDnB,OAAAU,WAAAV,QAAAM,UAAAN,EAAA,EAAA,IAAAG,MAAAV,OAAAO,QAAAW,IAAAX,QAAAiB,IAAAjB,QAAAmB,IAAAnB,QAAAS,WAAAT,QAAAoB,MAAAA,KAAApB,EAAA,EAAA,GAlBFoB;AAkBE;AAjCN,SAAAE,MAAA7B,OAAA8B,KAAA;AAAA,SAsBmCA,KAAG5B,SAAHF;AAAmB;AC9C/C,MAAM+B,WAAW,aCClBC,4BAA4BC,aAA4BC,CAAAA,YACrD;AAAA,EACLC,MAAM;AAAA,EACNC,QAAQ;AAAA,IACNC,OAAO,CACLC,WAAW;AAAA,MACTH,MAAMJ;AAAAA,MACNQ,MAAM;AAAA,MACNC,OAAO;AAAA,MACPC,aAAa;AAAA,MACbC,MAAMA,MAAM,oBAAA,UAAA,EAAE,UAAA,YAAA,CAAE;AAAA,MAChBC,YAAY;AAAA,QACVC,OAAQlC,CAAAA,UAAU,oBAAC,aAAU,cAAcwB,QAAQ,GAAIxB,MAAAA,CAAM;AAAA,MAAA;AAAA,IAC/D,CACD,CAAC;AAAA,EAAA;AAGR,EACD;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@madebywild/sanity-icon-field",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "UNLICENSED",
|
|
@@ -21,21 +21,21 @@
|
|
|
21
21
|
"access": "public"
|
|
22
22
|
},
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@madebywild/sanity-utils": "0.
|
|
24
|
+
"@madebywild/sanity-utils": "1.0.0"
|
|
25
25
|
},
|
|
26
26
|
"peerDependencies": {
|
|
27
27
|
"@sanity/ui": "^3.1",
|
|
28
|
-
"react": "^19",
|
|
29
|
-
"react-dom": "^19",
|
|
28
|
+
"react": "^19.2.2",
|
|
29
|
+
"react-dom": "^19.2.2",
|
|
30
30
|
"sanity": "^4.17 || ^5.0.0"
|
|
31
31
|
},
|
|
32
32
|
"devDependencies": {
|
|
33
33
|
"@sanity/pkg-utils": "^9.2",
|
|
34
|
-
"@types/react": "^19",
|
|
35
|
-
"@types/react-dom": "^19",
|
|
34
|
+
"@types/react": "^19.2.2",
|
|
35
|
+
"@types/react-dom": "^19.2.2",
|
|
36
36
|
"babel-plugin-react-compiler": "1.0.0",
|
|
37
|
-
"react": "^19",
|
|
38
|
-
"react-dom": "^19",
|
|
37
|
+
"react": "^19.2.2",
|
|
38
|
+
"react-dom": "^19.2.2",
|
|
39
39
|
"sanity": "^4.17 || ^5.0.0",
|
|
40
40
|
"typescript": "^5"
|
|
41
41
|
},
|
package/src/index.tsx
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { definePlugin, defineType } from "sanity";
|
|
2
|
-
import { IconInput } from "./input";
|
|
2
|
+
import { defaultRenderOption, defaultRenderSelected, IconInput } from "./input";
|
|
3
3
|
import { type FieldOptions, type PluginConfig, typeName } from "./types";
|
|
4
4
|
|
|
5
5
|
/** @public */
|
|
@@ -23,4 +23,4 @@ const wildSanityIconFieldPlugin = definePlugin<PluginConfig>((config) => {
|
|
|
23
23
|
};
|
|
24
24
|
});
|
|
25
25
|
|
|
26
|
-
export { wildSanityIconFieldPlugin, typeName, type PluginConfig, type FieldOptions };
|
|
26
|
+
export { wildSanityIconFieldPlugin, typeName, defaultRenderOption, defaultRenderSelected, type PluginConfig, type FieldOptions };
|
package/src/input.tsx
CHANGED
|
@@ -3,17 +3,23 @@ import { Box, Card, Flex, Text } from "@sanity/ui";
|
|
|
3
3
|
import { type StringInputProps, set, unset } from "sanity";
|
|
4
4
|
import type { FieldOptions, PluginConfig } from "./types";
|
|
5
5
|
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
/** @public */
|
|
7
|
+
function defaultRenderSelected(value: React.JSX.Element | string) {
|
|
8
|
+
if (typeof value === "string") return <Text size={2}>{value}</Text>;
|
|
9
|
+
return value;
|
|
8
10
|
}
|
|
9
11
|
|
|
10
|
-
|
|
12
|
+
/** @public */
|
|
13
|
+
function defaultRenderOption({ label, value }: { label?: React.JSX.Element | string; value: React.JSX.Element | string }) {
|
|
14
|
+
const Icon = typeof value === "string" ? <span>🧿</span> : value;
|
|
15
|
+
const Label = typeof label === "string" ? <Text size={2}>{label}</Text> : (label ?? value);
|
|
16
|
+
|
|
11
17
|
return (
|
|
12
18
|
<Card as="button">
|
|
13
19
|
<Flex align="center" padding={2}>
|
|
14
|
-
|
|
20
|
+
{Icon}
|
|
15
21
|
<Box flex={1} padding={2}>
|
|
16
|
-
|
|
22
|
+
{Label}
|
|
17
23
|
</Box>
|
|
18
24
|
</Flex>
|
|
19
25
|
</Card>
|
|
@@ -57,4 +63,4 @@ function IconInput({
|
|
|
57
63
|
);
|
|
58
64
|
}
|
|
59
65
|
|
|
60
|
-
export { IconInput };
|
|
66
|
+
export { IconInput, defaultRenderSelected, defaultRenderOption };
|
package/src/types.tsx
CHANGED
|
@@ -19,6 +19,7 @@ export type PluginConfig = {
|
|
|
19
19
|
iconList: ListItems;
|
|
20
20
|
/**
|
|
21
21
|
* A function to render the selected icon value.
|
|
22
|
+
* Note: Import `defaultRenderSelected` to use the default rendering.
|
|
22
23
|
* @example
|
|
23
24
|
* ```ts
|
|
24
25
|
* renderSelected: (value) => <svg><use href={`#icon-${value}`} /></svg>
|
|
@@ -26,6 +27,7 @@ export type PluginConfig = {
|
|
|
26
27
|
*/
|
|
27
28
|
renderSelected?: (value: string) => React.JSX.Element;
|
|
28
29
|
/** A function to render each icon option in the dropdown.
|
|
30
|
+
* Note: Import `defaultRenderOption` to use the default rendering.
|
|
29
31
|
* @example
|
|
30
32
|
* ```ts
|
|
31
33
|
* renderOption: (item) => <div>{item.label}</div>
|