@nice-digital/nds-a-z-list 4.0.2 → 4.0.4

package/package.json

@@ -1,8 +1,9 @@
 {
 	"name": "@nice-digital/nds-a-z-list",
-	"version": "4.0.2",
+	"version": "4.0.4",
 	"description": "A to Z list component for the NICE Design System",
 	"main": "es/AZList.js",
+	"types": "es/AZList.d.s",
 	"style": "scss/a-z-list.js",
 	"files": [
 		"es",
@@ -31,7 +32,7 @@
 	"homepage": "https://design-system.nice.org.uk/",
 	"license": "MIT",
 	"dependencies": {
-		"@nice-digital/nds-core": "^4.0.2"
+		"@nice-digital/nds-core": "^4.0.4"
 	},
 	"devDependencies": {
 		"@testing-library/jest-dom": "^5.16.5",
@@ -41,5 +42,5 @@
 		"@types/node": "^18.11.9",
 		"typescript": "^4.8.4"
 	},
-	"gitHead": "d8feb7beba5fffa49da42d6a550cb8f67a50727d"
+	"gitHead": "c8db07e6492c3b18564bd4f46c2ab098f185109a"
 }

package/es/AZList.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AZList.js","names":["React","PropTypes","AZList","props","Alphabet","alphabet","children","className","attrs","join","propTypes","elementType","isRequired","node","string","AZListItem","id","title","itemId","replace","toLowerCase"],"sources":["../src/AZList.js"],"sourcesContent":["import React from \"react\";\nimport PropTypes from \"prop-types\";\nimport \"../scss/a-z-list.scss\";\n\nexport const AZList = (props) => {\n\tconst { alphabet: Alphabet, children, className, ...attrs } = props;\n\n\treturn (\n\t\t<>\n\t\t\t<Alphabet className=\"a-z-list__alphabet\" />\n\t\t\t<ol className={[\"a-z-list\", className].join(\" \")} {...attrs}>\n\t\t\t\t{children}\n\t\t\t</ol>\n\t\t</>\n\t);\n};\n\nAZList.propTypes = {\n\talphabet: PropTypes.elementType.isRequired,\n\tchildren: PropTypes.node.isRequired,\n\tclassName: PropTypes.string\n};\n\nexport const AZListItem = (props) => {\n\tconst { id, title, children, className, ...attrs } = props;\n\n\tconst itemId = id || title.replace(\" \", \"\").toLowerCase();\n\n\treturn (\n\t\t<li className={[\"a-z-list__item\", className].join(\" \")} {...attrs}>\n\t\t\t<h2 className=\"a-z-list__item-heading\" id={itemId}>\n\t\t\t\t{title}\n\t\t\t</h2>\n\t\t\t{children}\n\t\t</li>\n\t);\n};\n\nAZListItem.propTypes = {\n\tid: PropTypes.string,\n\ttitle: PropTypes.string.isRequired,\n\tchildren: PropTypes.node.isRequired,\n\tclassName: PropTypes.string\n};\n"],"mappings":";;;;AAAA,OAAOA,KAAP,MAAkB,OAAlB;AACA,OAAOC,SAAP,MAAsB,YAAtB;AACA,OAAO,uBAAP;AAEA,OAAO,IAAMC,MAAM,GAAG,SAATA,MAAS,CAACC,KAAD,EAAW;EAChC,IAAkBC,QAAlB,GAA8DD,KAA9D,CAAQE,QAAR;EAAA,IAA4BC,QAA5B,GAA8DH,KAA9D,CAA4BG,QAA5B;EAAA,IAAsCC,SAAtC,GAA8DJ,KAA9D,CAAsCI,SAAtC;EAAA,IAAoDC,KAApD,iCAA8DL,KAA9D;;EAEA,oBACC,uDACC,oBAAC,QAAD;IAAU,SAAS,EAAC;EAApB,EADD,eAEC;IAAI,SAAS,EAAE,CAAC,UAAD,EAAaI,SAAb,EAAwBE,IAAxB,CAA6B,GAA7B;EAAf,GAAsDD,KAAtD,GACEF,QADF,CAFD,CADD;AAQA,CAXM;AAaPJ,MAAM,CAACQ,SAAP,GAAmB;EAClBL,QAAQ,EAAEJ,SAAS,CAACU,WAAV,CAAsBC,UADd;EAElBN,QAAQ,EAAEL,SAAS,CAACY,IAAV,CAAeD,UAFP;EAGlBL,SAAS,EAAEN,SAAS,CAACa;AAHH,CAAnB;AAMA,OAAO,IAAMC,UAAU,GAAG,SAAbA,UAAa,CAACZ,KAAD,EAAW;EACpC,IAAQa,EAAR,GAAqDb,KAArD,CAAQa,EAAR;EAAA,IAAYC,KAAZ,GAAqDd,KAArD,CAAYc,KAAZ;EAAA,IAAmBX,QAAnB,GAAqDH,KAArD,CAAmBG,QAAnB;EAAA,IAA6BC,SAA7B,GAAqDJ,KAArD,CAA6BI,SAA7B;EAAA,IAA2CC,KAA3C,iCAAqDL,KAArD;;EAEA,IAAMe,MAAM,GAAGF,EAAE,IAAIC,KAAK,CAACE,OAAN,CAAc,GAAd,EAAmB,EAAnB,EAAuBC,WAAvB,EAArB;EAEA,oBACC;IAAI,SAAS,EAAE,CAAC,gBAAD,EAAmBb,SAAnB,EAA8BE,IAA9B,CAAmC,GAAnC;EAAf,GAA4DD,KAA5D,gBACC;IAAI,SAAS,EAAC,wBAAd;IAAuC,EAAE,EAAEU;EAA3C,GACED,KADF,CADD,EAIEX,QAJF,CADD;AAQA,CAbM;AAePS,UAAU,CAACL,SAAX,GAAuB;EACtBM,EAAE,EAAEf,SAAS,CAACa,MADQ;EAEtBG,KAAK,EAAEhB,SAAS,CAACa,MAAV,CAAiBF,UAFF;EAGtBN,QAAQ,EAAEL,SAAS,CAACY,IAAV,CAAeD,UAHH;EAItBL,SAAS,EAAEN,SAAS,CAACa;AAJC,CAAvB"}

package/es/__tests__/nds-a-z-list.test.js

@@ -1,89 +0,0 @@
-"use strict";
-
-import React from "react";
-import { shallow, mount } from "enzyme";
-import toJson from "enzyme-to-json";
-import { AZList } from "../AZList";
-describe("A-Z List", function () {
-  var AZListItems = function AZListItems() {
-    return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement("li", null, "Item one"), /*#__PURE__*/React.createElement("li", null, "Item two"));
-  };
-
-  var mockAlphabet = function mockAlphabet() {
-    return /*#__PURE__*/React.createElement("ol", null, /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("a", {
-      href: "#a"
-    }, "A")), /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("a", {
-      href: "#b"
-    }, "B")));
-  };
-
-  it("should render without crashing", function () {
-    var wrapper = shallow( /*#__PURE__*/React.createElement(AZList, {
-      alphabet: mockAlphabet
-    }, /*#__PURE__*/React.createElement(AZListItems, null)));
-    expect(wrapper).toHaveLength(1);
-  });
-  it("should render an ordered list component", function () {
-    var wrapper = shallow( /*#__PURE__*/React.createElement(AZList, {
-      alphabet: mockAlphabet
-    }, /*#__PURE__*/React.createElement(AZListItems, null)));
-    expect(wrapper.children("ol").length).toEqual(1);
-  });
-  it("should render an ordered list with the expected class name", function () {
-    var wrapper = shallow( /*#__PURE__*/React.createElement(AZList, {
-      alphabet: mockAlphabet
-    }, /*#__PURE__*/React.createElement(AZListItems, null)));
-    expect(wrapper.children("ol").hasClass("a-z-list")).toEqual(true);
-  });
-  it("should append className prop to rendered class attribute for the list", function () {
-    var wrapper = shallow( /*#__PURE__*/React.createElement(AZList, {
-      className: "test",
-      alphabet: mockAlphabet
-    }, /*#__PURE__*/React.createElement(AZListItems, null)));
-    expect(wrapper.children("ol").hasClass("test")).toEqual(true);
-  });
-  it("should render additional props as attributes for the list", function () {
-    var wrapper = shallow( /*#__PURE__*/React.createElement(AZList, {
-      "aria-label": "test",
-      alphabet: mockAlphabet
-    }, /*#__PURE__*/React.createElement(AZListItems, null)));
-    expect(wrapper.children("ol").prop("aria-label")).toEqual("test");
-  });
-  it("should match snapshot with default attributes", function () {
-    var wrapper = mount( /*#__PURE__*/React.createElement(AZList, {
-      alphabet: mockAlphabet
-    }, /*#__PURE__*/React.createElement(AZListItems, null)));
-    expect(toJson(wrapper)).toMatchSnapshot();
-    wrapper.unmount();
-  });
-  it("should match snapshot with custom attributes", function () {
-    var wrapper = mount( /*#__PURE__*/React.createElement(AZList, {
-      className: "test-class",
-      "aria-label": "test-label",
-      alphabet: mockAlphabet
-    }, /*#__PURE__*/React.createElement(AZListItems, null)));
-    expect(toJson(wrapper)).toMatchSnapshot();
-    wrapper.unmount();
-  });
-  it("should render an alphabet component that has been passed in", function () {
-    var wrapper = mount( /*#__PURE__*/React.createElement(AZList, {
-      alphabet: mockAlphabet
-    }, /*#__PURE__*/React.createElement(AZListItems, null)));
-    expect(wrapper.find(mockAlphabet)).toHaveLength(1);
-    wrapper.unmount();
-  });
-  it("should render an alphabet component with a custom class", function () {
-    var customAlphabet = function customAlphabet() {
-      return /*#__PURE__*/React.createElement("div", {
-        className: "test-class"
-      }, "Alphabet");
-    };
-
-    var wrapper = mount( /*#__PURE__*/React.createElement(AZList, {
-      alphabet: customAlphabet
-    }, /*#__PURE__*/React.createElement(AZListItems, null)));
-    expect(wrapper.find(customAlphabet).childAt(0).hasClass("test-class")).toEqual(true);
-    wrapper.unmount();
-  });
-});
-//# sourceMappingURL=nds-a-z-list.test.js.map

package/es/__tests__/nds-a-z-list.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nds-a-z-list.test.js","names":["React","shallow","mount","toJson","AZList","describe","AZListItems","mockAlphabet","it","wrapper","expect","toHaveLength","children","length","toEqual","hasClass","prop","toMatchSnapshot","unmount","find","customAlphabet","childAt"],"sources":["../../src/__tests__/nds-a-z-list.test.js"],"sourcesContent":["\"use strict\";\n\nimport React from \"react\";\nimport { shallow, mount } from \"enzyme\";\nimport toJson from \"enzyme-to-json\";\n\nimport { AZList } from \"../AZList\";\n\ndescribe(\"A-Z List\", () => {\n\tconst AZListItems = () => (\n\t\t<>\n\t\t\t<li>Item one</li>\n\t\t\t<li>Item two</li>\n\t\t</>\n\t);\n\tconst mockAlphabet = () => (\n\t\t<ol>\n\t\t\t<li>\n\t\t\t\t<a href=\"#a\">A</a>\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\t<a href=\"#b\">B</a>\n\t\t\t</li>\n\t\t</ol>\n\t);\n\n\tit(\"should render without crashing\", () => {\n\t\tconst wrapper = shallow(\n\t\t\t<AZList alphabet={mockAlphabet}>\n\t\t\t\t<AZListItems />\n\t\t\t</AZList>\n\t\t);\n\t\texpect(wrapper).toHaveLength(1);\n\t});\n\n\tit(\"should render an ordered list component\", () => {\n\t\tconst wrapper = shallow(\n\t\t\t<AZList alphabet={mockAlphabet}>\n\t\t\t\t<AZListItems />\n\t\t\t</AZList>\n\t\t);\n\t\texpect(wrapper.children(\"ol\").length).toEqual(1);\n\t});\n\n\tit(\"should render an ordered list with the expected class name\", () => {\n\t\tconst wrapper = shallow(\n\t\t\t<AZList alphabet={mockAlphabet}>\n\t\t\t\t<AZListItems />\n\t\t\t</AZList>\n\t\t);\n\t\texpect(wrapper.children(\"ol\").hasClass(\"a-z-list\")).toEqual(true);\n\t});\n\n\tit(\"should append className prop to rendered class attribute for the list\", () => {\n\t\tconst wrapper = shallow(\n\t\t\t<AZList className=\"test\" alphabet={mockAlphabet}>\n\t\t\t\t<AZListItems />\n\t\t\t</AZList>\n\t\t);\n\t\texpect(wrapper.children(\"ol\").hasClass(\"test\")).toEqual(true);\n\t});\n\n\tit(\"should render additional props as attributes for the list\", () => {\n\t\tconst wrapper = shallow(\n\t\t\t<AZList aria-label=\"test\" alphabet={mockAlphabet}>\n\t\t\t\t<AZListItems />\n\t\t\t</AZList>\n\t\t);\n\t\texpect(wrapper.children(\"ol\").prop(\"aria-label\")).toEqual(\"test\");\n\t});\n\n\tit(\"should match snapshot with default attributes\", () => {\n\t\tconst wrapper = mount(\n\t\t\t<AZList alphabet={mockAlphabet}>\n\t\t\t\t<AZListItems />\n\t\t\t</AZList>\n\t\t);\n\t\texpect(toJson(wrapper)).toMatchSnapshot();\n\t\twrapper.unmount();\n\t});\n\n\tit(\"should match snapshot with custom attributes\", () => {\n\t\tconst wrapper = mount(\n\t\t\t<AZList\n\t\t\t\tclassName=\"test-class\"\n\t\t\t\taria-label=\"test-label\"\n\t\t\t\talphabet={mockAlphabet}\n\t\t\t>\n\t\t\t\t<AZListItems />\n\t\t\t</AZList>\n\t\t);\n\t\texpect(toJson(wrapper)).toMatchSnapshot();\n\t\twrapper.unmount();\n\t});\n\n\tit(\"should render an alphabet component that has been passed in\", () => {\n\t\tconst wrapper = mount(\n\t\t\t<AZList alphabet={mockAlphabet}>\n\t\t\t\t<AZListItems />\n\t\t\t</AZList>\n\t\t);\n\t\texpect(wrapper.find(mockAlphabet)).toHaveLength(1);\n\t\twrapper.unmount();\n\t});\n\n\tit(\"should render an alphabet component with a custom class\", () => {\n\t\tconst customAlphabet = () => <div className=\"test-class\">Alphabet</div>;\n\t\tconst wrapper = mount(\n\t\t\t<AZList alphabet={customAlphabet}>\n\t\t\t\t<AZListItems />\n\t\t\t</AZList>\n\t\t);\n\t\texpect(\n\t\t\twrapper.find(customAlphabet).childAt(0).hasClass(\"test-class\")\n\t\t).toEqual(true);\n\t\twrapper.unmount();\n\t});\n});\n"],"mappings":"AAAA;;AAEA,OAAOA,KAAP,MAAkB,OAAlB;AACA,SAASC,OAAT,EAAkBC,KAAlB,QAA+B,QAA/B;AACA,OAAOC,MAAP,MAAmB,gBAAnB;AAEA,SAASC,MAAT,QAAuB,WAAvB;AAEAC,QAAQ,CAAC,UAAD,EAAa,YAAM;EAC1B,IAAMC,WAAW,GAAG,SAAdA,WAAc;IAAA,oBACnB,uDACC,2CADD,eAEC,2CAFD,CADmB;EAAA,CAApB;;EAMA,IAAMC,YAAY,GAAG,SAAfA,YAAe;IAAA,oBACpB,6CACC,6CACC;MAAG,IAAI,EAAC;IAAR,OADD,CADD,eAIC,6CACC;MAAG,IAAI,EAAC;IAAR,OADD,CAJD,CADoB;EAAA,CAArB;;EAWAC,EAAE,CAAC,gCAAD,EAAmC,YAAM;IAC1C,IAAMC,OAAO,GAAGR,OAAO,eACtB,oBAAC,MAAD;MAAQ,QAAQ,EAAEM;IAAlB,gBACC,oBAAC,WAAD,OADD,CADsB,CAAvB;IAKAG,MAAM,CAACD,OAAD,CAAN,CAAgBE,YAAhB,CAA6B,CAA7B;EACA,CAPC,CAAF;EASAH,EAAE,CAAC,yCAAD,EAA4C,YAAM;IACnD,IAAMC,OAAO,GAAGR,OAAO,eACtB,oBAAC,MAAD;MAAQ,QAAQ,EAAEM;IAAlB,gBACC,oBAAC,WAAD,OADD,CADsB,CAAvB;IAKAG,MAAM,CAACD,OAAO,CAACG,QAAR,CAAiB,IAAjB,EAAuBC,MAAxB,CAAN,CAAsCC,OAAtC,CAA8C,CAA9C;EACA,CAPC,CAAF;EASAN,EAAE,CAAC,4DAAD,EAA+D,YAAM;IACtE,IAAMC,OAAO,GAAGR,OAAO,eACtB,oBAAC,MAAD;MAAQ,QAAQ,EAAEM;IAAlB,gBACC,oBAAC,WAAD,OADD,CADsB,CAAvB;IAKAG,MAAM,CAACD,OAAO,CAACG,QAAR,CAAiB,IAAjB,EAAuBG,QAAvB,CAAgC,UAAhC,CAAD,CAAN,CAAoDD,OAApD,CAA4D,IAA5D;EACA,CAPC,CAAF;EASAN,EAAE,CAAC,uEAAD,EAA0E,YAAM;IACjF,IAAMC,OAAO,GAAGR,OAAO,eACtB,oBAAC,MAAD;MAAQ,SAAS,EAAC,MAAlB;MAAyB,QAAQ,EAAEM;IAAnC,gBACC,oBAAC,WAAD,OADD,CADsB,CAAvB;IAKAG,MAAM,CAACD,OAAO,CAACG,QAAR,CAAiB,IAAjB,EAAuBG,QAAvB,CAAgC,MAAhC,CAAD,CAAN,CAAgDD,OAAhD,CAAwD,IAAxD;EACA,CAPC,CAAF;EASAN,EAAE,CAAC,2DAAD,EAA8D,YAAM;IACrE,IAAMC,OAAO,GAAGR,OAAO,eACtB,oBAAC,MAAD;MAAQ,cAAW,MAAnB;MAA0B,QAAQ,EAAEM;IAApC,gBACC,oBAAC,WAAD,OADD,CADsB,CAAvB;IAKAG,MAAM,CAACD,OAAO,CAACG,QAAR,CAAiB,IAAjB,EAAuBI,IAAvB,CAA4B,YAA5B,CAAD,CAAN,CAAkDF,OAAlD,CAA0D,MAA1D;EACA,CAPC,CAAF;EASAN,EAAE,CAAC,+CAAD,EAAkD,YAAM;IACzD,IAAMC,OAAO,GAAGP,KAAK,eACpB,oBAAC,MAAD;MAAQ,QAAQ,EAAEK;IAAlB,gBACC,oBAAC,WAAD,OADD,CADoB,CAArB;IAKAG,MAAM,CAACP,MAAM,CAACM,OAAD,CAAP,CAAN,CAAwBQ,eAAxB;IACAR,OAAO,CAACS,OAAR;EACA,CARC,CAAF;EAUAV,EAAE,CAAC,8CAAD,EAAiD,YAAM;IACxD,IAAMC,OAAO,GAAGP,KAAK,eACpB,oBAAC,MAAD;MACC,SAAS,EAAC,YADX;MAEC,cAAW,YAFZ;MAGC,QAAQ,EAAEK;IAHX,gBAKC,oBAAC,WAAD,OALD,CADoB,CAArB;IASAG,MAAM,CAACP,MAAM,CAACM,OAAD,CAAP,CAAN,CAAwBQ,eAAxB;IACAR,OAAO,CAACS,OAAR;EACA,CAZC,CAAF;EAcAV,EAAE,CAAC,6DAAD,EAAgE,YAAM;IACvE,IAAMC,OAAO,GAAGP,KAAK,eACpB,oBAAC,MAAD;MAAQ,QAAQ,EAAEK;IAAlB,gBACC,oBAAC,WAAD,OADD,CADoB,CAArB;IAKAG,MAAM,CAACD,OAAO,CAACU,IAAR,CAAaZ,YAAb,CAAD,CAAN,CAAmCI,YAAnC,CAAgD,CAAhD;IACAF,OAAO,CAACS,OAAR;EACA,CARC,CAAF;EAUAV,EAAE,CAAC,yDAAD,EAA4D,YAAM;IACnE,IAAMY,cAAc,GAAG,SAAjBA,cAAiB;MAAA,oBAAM;QAAK,SAAS,EAAC;MAAf,cAAN;IAAA,CAAvB;;IACA,IAAMX,OAAO,GAAGP,KAAK,eACpB,oBAAC,MAAD;MAAQ,QAAQ,EAAEkB;IAAlB,gBACC,oBAAC,WAAD,OADD,CADoB,CAArB;IAKAV,MAAM,CACLD,OAAO,CAACU,IAAR,CAAaC,cAAb,EAA6BC,OAA7B,CAAqC,CAArC,EAAwCN,QAAxC,CAAiD,YAAjD,CADK,CAAN,CAEED,OAFF,CAEU,IAFV;IAGAL,OAAO,CAACS,OAAR;EACA,CAXC,CAAF;AAYA,CA7GO,CAAR"}