@uob-web-and-digital/component-library 0.0.54 → 0.0.55

package/dist/components/organisms/SearchCourses/SearchCourses.d.ts

@@ -19,6 +19,10 @@ export interface SearchCoursesProps {
      * Title for module
      */
     title?: string;
+    /**
+     * Optional description for module
+     */
+    description?: string;
     /**
      * Default value to use for the search term
      */
@@ -27,10 +31,6 @@ export interface SearchCoursesProps {
      * Placeholder text
      */
     placeholder: string;
-    /**
-     * Facet of the filter
-     */
-    facet?: string;
     /**
      * Display name of the filter
      */
@@ -47,10 +47,6 @@ export interface SearchCoursesProps {
      * Default value for filter
      */
     defaultFilter?: string;
-    /**
-     * Results url
-     */
-    resultsUrl: string;
     /**
      * The wrapped version of this component is used for Hero
      */
@@ -65,11 +61,19 @@ export interface SearchCoursesProps {
     onGrid?: boolean;
     titleTag?: 'h1' | 'h2';
     /**
-     * Use onClick event on Search button (eg to update search results on the same page)
+     * Function to handle what happen whens when form is submitted
+     */
+    formSubmitHandler?: () => void | null;
+    /**
+     * Function to handle what happen whens when filters change
+     */
+    filterChangeHandler?: () => void | null;
+    /**
+     * Function to handle what happen whens when search term changes
      */
-    useOnClickHandler?: () => void | null;
+    searchTermChangeHandler?: () => void | null;
 }
 /**
  * Search component
  */
-export default function SearchCourses({ theme, inverse, title, defaultSearchTerm, placeholder, facet, filterTitle, filterFieldName, filterOptions, defaultFilter, resultsUrl, wrapped, fullWidth, onGrid, titleTag, useOnClickHandler }: SearchCoursesProps): ReactElement;
+export default function SearchCourses({ theme, inverse, title, description, defaultSearchTerm, placeholder, filterTitle, filterFieldName, filterOptions, defaultFilter, wrapped, fullWidth, onGrid, titleTag, formSubmitHandler, filterChangeHandler, searchTermChangeHandler }: SearchCoursesProps): ReactElement;

package/dist/index.d.ts

@@ -425,6 +425,10 @@ interface SearchCoursesProps {
      * Title for module
      */
     title?: string;
+    /**
+     * Optional description for module
+     */
+    description?: string;
     /**
      * Default value to use for the search term
      */
@@ -433,10 +437,6 @@ interface SearchCoursesProps {
      * Placeholder text
      */
     placeholder: string;
-    /**
-     * Facet of the filter
-     */
-    facet?: string;
     /**
      * Display name of the filter
      */
@@ -453,10 +453,6 @@ interface SearchCoursesProps {
      * Default value for filter
      */
     defaultFilter?: string;
-    /**
-     * Results url
-     */
-    resultsUrl: string;
     /**
      * The wrapped version of this component is used for Hero
      */
@@ -471,14 +467,22 @@ interface SearchCoursesProps {
     onGrid?: boolean;
     titleTag?: 'h1' | 'h2';
     /**
-     * Use onClick event on Search button (eg to update search results on the same page)
+     * Function to handle what happen whens when form is submitted
+     */
+    formSubmitHandler?: () => void | null;
+    /**
+     * Function to handle what happen whens when filters change
+     */
+    filterChangeHandler?: () => void | null;
+    /**
+     * Function to handle what happen whens when search term changes
      */
-    useOnClickHandler?: () => void | null;
+    searchTermChangeHandler?: () => void | null;
 }
 /**
  * Search component
  */
-declare function SearchCourses({ theme, inverse, title, defaultSearchTerm, placeholder, facet, filterTitle, filterFieldName, filterOptions, defaultFilter, resultsUrl, wrapped, fullWidth, onGrid, titleTag, useOnClickHandler }: SearchCoursesProps): ReactElement;
+declare function SearchCourses({ theme, inverse, title, description, defaultSearchTerm, placeholder, filterTitle, filterFieldName, filterOptions, defaultFilter, wrapped, fullWidth, onGrid, titleTag, formSubmitHandler, filterChangeHandler, searchTermChangeHandler }: SearchCoursesProps): ReactElement;
 
 interface SignPostProps {
     /**