@newskit-render/standalone-components 0.5.2 → 0.6.0

package/README.md

@@ -27,8 +27,14 @@ For npm:
     - text: string // optional
   - `size` can be `large` or `small`.
 
+2. Help-hub pages: the package provides 2 pages:
+  - Search page: where the user is able to search their queries and see the most common questions. 
+  - Result page: displaying the relevant results based on the user query. To facilitate the search we are using Algolia.
+
+The Help-hub pages will work independent of other components and customized using the context.
 # How to use
 
+1. Article recommendations:
 First, you need to fetch some article recommendations with the recommendationsProvider function, then iterate over the returned array and use the ArticleRecommendation component to display them.
 
 Example of use:
@@ -79,5 +85,22 @@ export async function getServerSideProps(context) {
 }
 ```
 
+2. Help-hub pages:
+
+Example of use:
+
+```typescript
+import React from 'react'
+import { SearchPage } from '@newskit-render/standalone-components'
+import Layout from '../../components/layout'
+
+const HelpHub = () => (
+  <Layout>
+    <SearchPage />
+  </Layout>
+)
+
+export default HelpHub
+```
 .
 .

package/dist/cjs/help-hub/index.d.ts

@@ -0,0 +1,2 @@
+export * from './results-page';
+export * from './search-page';

package/dist/cjs/help-hub/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./results-page"), exports);
+__exportStar(require("./search-page"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/help-hub/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/help-hub/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iDAA8B;AAC9B,gDAA6B"}

package/dist/cjs/help-hub/results-page/ResultsPage.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+export declare const ResultsPage: React.FC;
+export default ResultsPage;

package/dist/cjs/help-hub/results-page/ResultsPage.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResultsPage = void 0;
+var react_1 = __importDefault(require("react"));
+var ResultsPage = function () { return (react_1.default.createElement("div", null,
+    react_1.default.createElement("h2", null, "Results page"))); };
+exports.ResultsPage = ResultsPage;
+exports.default = exports.ResultsPage;
+//# sourceMappingURL=ResultsPage.js.map

package/dist/cjs/help-hub/results-page/ResultsPage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResultsPage.js","sourceRoot":"","sources":["../../../../src/help-hub/results-page/ResultsPage.tsx"],"names":[],"mappings":";;;;;;AAAA,gDAAyB;AAElB,IAAM,WAAW,GAAa,cAAM,OAAA,CACzC;IACE,yDAAqB,CACjB,CACP,EAJ0C,CAI1C,CAAA;AAJY,QAAA,WAAW,eAIvB;AAED,kBAAe,mBAAW,CAAA"}

package/dist/cjs/help-hub/results-page/index.d.ts

@@ -0,0 +1 @@
+export * from './ResultsPage';

package/dist/cjs/help-hub/results-page/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ResultsPage"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/help-hub/results-page/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/help-hub/results-page/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gDAA6B"}

package/dist/cjs/help-hub/search-page/SearchPage.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+export declare const SearchPage: React.FC;
+export default SearchPage;

package/dist/cjs/help-hub/search-page/SearchPage.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchPage = void 0;
+var react_1 = __importDefault(require("react"));
+var SearchPage = function () { return (react_1.default.createElement("div", null,
+    react_1.default.createElement("h2", null, "How can we help?"))); };
+exports.SearchPage = SearchPage;
+exports.default = exports.SearchPage;
+//# sourceMappingURL=SearchPage.js.map

package/dist/cjs/help-hub/search-page/SearchPage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SearchPage.js","sourceRoot":"","sources":["../../../../src/help-hub/search-page/SearchPage.tsx"],"names":[],"mappings":";;;;;;AAAA,gDAAyB;AAElB,IAAM,UAAU,GAAa,cAAM,OAAA,CACxC;IACE,6DAAyB,CACrB,CACP,EAJyC,CAIzC,CAAA;AAJY,QAAA,UAAU,cAItB;AAED,kBAAe,kBAAU,CAAA"}

package/dist/cjs/help-hub/search-page/index.d.ts

@@ -0,0 +1 @@
+export * from './SearchPage';

package/dist/cjs/help-hub/search-page/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./SearchPage"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/help-hub/search-page/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/help-hub/search-page/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAA4B"}

package/dist/cjs/index.d.ts

@@ -1 +1,2 @@
 export * from './article-recommendations';
+export * from './help-hub';

package/dist/cjs/index.js

@@ -11,4 +11,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./article-recommendations"), exports);
+__exportStar(require("./help-hub"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4DAAyC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4DAAyC;AACzC,6CAA0B"}

package/dist/help-hub/index.d.ts

@@ -0,0 +1,2 @@
+export * from './results-page';
+export * from './search-page';

package/dist/help-hub/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./results-page"), exports);
+__exportStar(require("./search-page"), exports);
+//# sourceMappingURL=index.js.map

package/dist/help-hub/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/help-hub/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iDAA8B;AAC9B,gDAA6B"}

package/dist/help-hub/results-page/ResultsPage.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+export declare const ResultsPage: React.FC;
+export default ResultsPage;

package/dist/help-hub/results-page/ResultsPage.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResultsPage = void 0;
+var react_1 = __importDefault(require("react"));
+var ResultsPage = function () { return (react_1.default.createElement("div", null,
+    react_1.default.createElement("h2", null, "Results page"))); };
+exports.ResultsPage = ResultsPage;
+exports.default = exports.ResultsPage;
+//# sourceMappingURL=ResultsPage.js.map

package/dist/help-hub/results-page/ResultsPage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResultsPage.js","sourceRoot":"","sources":["../../../src/help-hub/results-page/ResultsPage.tsx"],"names":[],"mappings":";;;;;;AAAA,gDAAyB;AAElB,IAAM,WAAW,GAAa,cAAM,OAAA,CACzC;IACE,yDAAqB,CACjB,CACP,EAJ0C,CAI1C,CAAA;AAJY,QAAA,WAAW,eAIvB;AAED,kBAAe,mBAAW,CAAA"}

package/dist/help-hub/results-page/index.d.ts

@@ -0,0 +1 @@
+export * from './ResultsPage';

package/dist/help-hub/results-page/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ResultsPage"), exports);
+//# sourceMappingURL=index.js.map

package/dist/help-hub/results-page/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/help-hub/results-page/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gDAA6B"}

package/dist/help-hub/search-page/SearchPage.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+export declare const SearchPage: React.FC;
+export default SearchPage;

package/dist/help-hub/search-page/SearchPage.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchPage = void 0;
+var react_1 = __importDefault(require("react"));
+var SearchPage = function () { return (react_1.default.createElement("div", null,
+    react_1.default.createElement("h2", null, "How can we help?"))); };
+exports.SearchPage = SearchPage;
+exports.default = exports.SearchPage;
+//# sourceMappingURL=SearchPage.js.map

package/dist/help-hub/search-page/SearchPage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SearchPage.js","sourceRoot":"","sources":["../../../src/help-hub/search-page/SearchPage.tsx"],"names":[],"mappings":";;;;;;AAAA,gDAAyB;AAElB,IAAM,UAAU,GAAa,cAAM,OAAA,CACxC;IACE,6DAAyB,CACrB,CACP,EAJyC,CAIzC,CAAA;AAJY,QAAA,UAAU,cAItB;AAED,kBAAe,kBAAU,CAAA"}

package/dist/help-hub/search-page/index.d.ts

@@ -0,0 +1 @@
+export * from './SearchPage';

package/dist/help-hub/search-page/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./SearchPage"), exports);
+//# sourceMappingURL=index.js.map

package/dist/help-hub/search-page/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/help-hub/search-page/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAA4B"}

package/dist/index.d.ts

@@ -1 +1,2 @@
 export * from './article-recommendations';
+export * from './help-hub';

package/dist/index.js

@@ -11,4 +11,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./article-recommendations"), exports);
+__exportStar(require("./help-hub"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4DAAyC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4DAAyC;AACzC,6CAA0B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newskit-render/standalone-components",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "description": "Newskit Render Standalone Components",
   "author": "",
   "license": "UNLICENSED",