diff --git a/THIRD-PARTY-NOTICES b/THIRD-PARTY-NOTICES index ec897d515..c74c079d1 100644 --- a/THIRD-PARTY-NOTICES +++ b/THIRD-PARTY-NOTICES @@ -266,105 +266,6 @@ THIS SOFTWARE. ----------- -The following NPM package may be included in this product: - - - @microsoft/api-documenter@7.15.3 - -This package contains the following license and notice below: - -@microsoft/api-documenter - -Copyright (c) Microsoft Corporation. All rights reserved. - -MIT License - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------ - -The following NPM packages may be included in this product: - - - @microsoft/api-extractor-model@7.15.3 - - @microsoft/api-extractor@7.19.4 - -These packages each contain the following license and notice below: - -@microsoft/api-extractor - -Copyright (c) Microsoft Corporation. All rights reserved. - -MIT License - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------ - -The following NPM packages may be included in this product: - - - @microsoft/tsdoc-config@0.15.2 - - @microsoft/tsdoc@0.13.2 - -These packages each contain the following license and notice below: - -Copyright (c) Microsoft Corporation. All rights reserved. - -MIT License - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------ - The following NPM packages may be included in this product: - @nodelib/fs.scandir@2.1.5 @@ -757,105 +658,6 @@ SOFTWARE. ----------- -The following NPM package may be included in this product: - - - @rushstack/node-core-library@3.45.0 - -This package contains the following license and notice below: - -@rushstack/node-core-library - -Copyright (c) Microsoft Corporation. All rights reserved. - -MIT License - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------ - -The following NPM package may be included in this product: - - - @rushstack/rig-package@0.3.7 - -This package contains the following license and notice below: - -@rushstack/rig-package - -Copyright (c) Microsoft Corporation. All rights reserved. - -MIT License - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------ - -The following NPM package may be included in this product: - - - @rushstack/ts-command-line@4.10.6 - -This package contains the following license and notice below: - -@rushstack/ts-command-line - -Copyright (c) Microsoft Corporation. All rights reserved. - -MIT License - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------ - The following NPM package may be included in this product: - @swc/helpers@0.5.2 @@ -1097,66 +899,6 @@ SOFTWARE. ----------- -The following NPM package may be included in this product: - - - @types/argparse@1.0.38 - -This package contains the following license and notice below: - -MIT License - - Copyright (c) Microsoft Corporation. All rights reserved. - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to deal - in the Software without restriction, including without limitation the rights - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE - ------------ - -The following NPM package may be included in this product: - - - @types/node@12.20.24 - -This package contains the following license and notice below: - -MIT License - - Copyright (c) Microsoft Corporation. - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to deal - in the Software without restriction, including without limitation the rights - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE - ------------ - The following NPM package may be included in this product: - @types/warning@3.0.0 @@ -1519,36 +1261,6 @@ THE SOFTWARE. ----------- -The following NPM package may be included in this product: - - - ajv@6.12.6 - -This package contains the following license and notice below: - -The MIT License (MIT) - -Copyright (c) 2015-2017 Evgeny Poberezkin - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. - ------------ - The following NPM package may be included in this product: - anymatch@3.1.2 @@ -1603,50 +1315,20 @@ SOFTWARE. ----------- -The following NPM package may be included in this product: +The following NPM packages may be included in this product: - - argparse@1.0.10 + - binary-extensions@2.2.0 + - is-binary-path@2.1.0 -This package contains the following license and notice below: +These packages each contain the following license and notice below: -(The MIT License) +MIT License -Copyright (C) 2012 by Vitaly Puzrin +Copyright (c) 2019 Sindre Sorhus (https://sindresorhus.com), Paul Miller (https://paulmillr.com) -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. - ------------ - -The following NPM packages may be included in this product: - - - binary-extensions@2.2.0 - - is-binary-path@2.1.0 - -These packages each contain the following license and notice below: - -MIT License - -Copyright (c) 2019 Sindre Sorhus (https://sindresorhus.com), Paul Miller (https://paulmillr.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @@ -1790,71 +1472,6 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI ----------- -The following NPM package may be included in this product: - - - colors@1.2.5 - -This package contains the following license and notice below: - -MIT License - -Original Library - - Copyright (c) Marak Squires - -Additional Functionality - - Copyright (c) Sindre Sorhus (sindresorhus.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. - ------------ - -The following NPM package may be included in this product: - - - commander@2.20.3 - -This package contains the following license and notice below: - -(The MIT License) - -Copyright (c) 2011 TJ Holowaychuk - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -'Software'), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------ - The following NPM package may be included in this product: - core-js-pure@3.32.2 @@ -1967,12 +1584,11 @@ IN THE SOFTWARE. ----------- -The following NPM packages may be included in this product: +The following NPM package may be included in this product: - cssesc@3.0.0 - - punycode@2.1.1 -These packages each contain the following license and notice below: +This package contains the following license and notice below: Copyright Mathias Bynens @@ -2246,97 +1862,6 @@ THIS SOFTWARE. ----------- -The following NPM package may be included in this product: - - - esprima@4.0.1 - -This package contains the following license and notice below: - -Copyright JS Foundation and other contributors, https://js.foundation/ - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY -DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES -(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; -LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND -ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF -THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - ------------ - -The following NPM packages may be included in this product: - - - fast-deep-equal@3.1.3 - - json-schema-traverse@0.4.1 - -These packages each contain the following license and notice below: - -MIT License - -Copyright (c) 2017 Evgeny Poberezkin - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. - ------------ - -The following NPM package may be included in this product: - - - fast-json-stable-stringify@2.1.0 - -This package contains the following license and notice below: - -This software is released under the MIT license: - -Copyright (c) 2017 Evgeny Poberezkin -Copyright (c) 2013 James Halliday - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------ - The following NPM package may be included in this product: - fastq@1.13.0 @@ -2391,30 +1916,6 @@ THE SOFTWARE. ----------- -The following NPM package may be included in this product: - - - fs-extra@7.0.1 - -This package contains the following license and notice below: - -(The MIT License) - -Copyright (c) 2011-2017 JP Richardson - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files -(the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, - merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE -WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS -OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, - ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------ - The following NPM package may be included in this product: - fsevents@2.3.2 @@ -2498,12 +1999,11 @@ THIS SOFTWARE. ----------- -The following NPM packages may be included in this product: +The following NPM package may be included in this product: - get-stream@6.0.1 - - strip-json-comments@3.1.1 -These packages each contain the following license and notice below: +This package contains the following license and notice below: MIT License @@ -2593,30 +2093,6 @@ IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ----------- -The following NPM package may be included in this product: - - - graceful-fs@4.2.9 - -This package contains the following license and notice below: - -The ISC License - -Copyright (c) Isaac Z. Schlueter, Ben Noordhuis, and Contributors - -Permission to use, copy, modify, and/or distribute this software for any -purpose with or without fee is hereby granted, provided that the above -copyright notice and this permission notice appear in all copies. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR -IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - ------------ - The following NPM package may be included in this product: - grid-index@1.1.0 @@ -2751,25 +2227,6 @@ SOFTWARE. ----------- -The following NPM packages may be included in this product: - - - import-lazy@4.0.0 - - quick-lru@5.1.1 - -These packages each contain the following license and notice below: - -MIT License - -Copyright (c) Sindre Sorhus (sindresorhus.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------ - The following NPM package may be included in this product: - is-core-module@2.9.0 @@ -2859,36 +2316,6 @@ THE SOFTWARE. ----------- -The following NPM package may be included in this product: - - - jju@1.4.0 - -This package contains the following license and notice below: - -(The MIT License) - -Copyright (c) 2013 Alex Kocharin - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. - ------------ - The following NPM package may be included in this product: - js-levenshtein@1.1.6 @@ -2949,60 +2376,6 @@ THE SOFTWARE. ----------- -The following NPM package may be included in this product: - - - js-yaml@3.13.1 - -This package contains the following license and notice below: - -(The MIT License) - -Copyright (C) 2011-2015 by Vitaly Puzrin - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. - ------------ - -The following NPM package may be included in this product: - - - jsonfile@4.0.0 - -This package contains the following license and notice below: - -(The MIT License) - -Copyright (c) 2012-2015, JP Richardson - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files -(the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, - merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE -WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS -OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, - ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------ - The following NPM packages may be included in this product: - kdbush@3.0.0 @@ -3093,121 +2466,9 @@ The following NPM packages may be included in this product: - lodash-es@4.17.21 - lodash@4.17.21 -These packages each contain the following license and notice below: - -Copyright OpenJS Foundation and other contributors - -Based on Underscore.js, copyright Jeremy Ashkenas, -DocumentCloud and Investigative Reporters & Editors - -This software consists of voluntary contributions made by many -individuals. For exact contribution history, see the revision history -available at https://github.com/lodash/lodash - -The following license applies to all parts of this software except as -documented below: - -==== - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -==== - -Copyright and related rights for sample code are waived via CC0. Sample -code is defined as all source code displayed within the prose of the -documentation. - -CC0: http://creativecommons.org/publicdomain/zero/1.0/ - -==== - -Files located in the node_modules and vendor directories are externally -maintained libraries used by this software which have their own -licenses; we recommend you read them, as their terms may differ from the -terms above. - ------------ - -The following NPM package may be included in this product: - - - lodash.get@4.4.2 - -This package contains the following license and notice below: - -Copyright jQuery Foundation and other contributors - -Based on Underscore.js, copyright Jeremy Ashkenas, -DocumentCloud and Investigative Reporters & Editors - -This software consists of voluntary contributions made by many -individuals. For exact contribution history, see the revision history -available at https://github.com/lodash/lodash - -The following license applies to all parts of this software except as -documented below: - -==== - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -==== - -Copyright and related rights for sample code are waived via CC0. Sample -code is defined as all source code displayed within the prose of the -documentation. - -CC0: http://creativecommons.org/publicdomain/zero/1.0/ - -==== - -Files located in the node_modules and vendor directories are externally -maintained libraries used by this software which have their own -licenses; we recommend you read them, as their terms may differ from the -terms above. - ------------ - -The following NPM package may be included in this product: - - - lodash.isequal@4.5.0 - -This package contains the following license and notice below: +These packages each contain the following license and notice below: -Copyright JS Foundation and other contributors +Copyright OpenJS Foundation and other contributors Based on Underscore.js, copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors @@ -3287,32 +2548,6 @@ THE SOFTWARE. ----------- -The following NPM packages may be included in this product: - - - lru-cache@6.0.0 - - semver@7.3.5 - - yallist@4.0.0 - -These packages each contain the following license and notice below: - -The ISC License - -Copyright (c) Isaac Z. Schlueter and Contributors - -Permission to use, copy, modify, and/or distribute this software for any -purpose with or without fee is hereby granted, provided that the above -copyright notice and this permission notice appear in all copies. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR -IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - ------------ - The following NPM package may be included in this product: - mapbox-gl@2.10.0 @@ -4102,6 +3337,24 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ----------- +The following NPM package may be included in this product: + + - quick-lru@5.1.1 + +This package contains the following license and notice below: + +MIT License + +Copyright (c) Sindre Sorhus (sindresorhus.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +----------- + The following NPM package may be included in this product: - react-collapsed@3.6.0 @@ -4514,13 +3767,11 @@ THE SOFTWARE. ----------- -The following NPM packages may be included in this product: +The following NPM package may be included in this product: - - resolve@1.17.0 - - resolve@1.19.0 - resolve@1.22.1 -These packages each contain the following license and notice below: +This package contains the following license and notice below: MIT License @@ -4611,12 +3862,11 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ----------- -The following NPM packages may be included in this product: +The following NPM package may be included in this product: - source-map-js@1.0.2 - - source-map@0.6.1 -These packages each contain the following license and notice below: +This package contains the following license and notice below: Copyright (c) 2009-2011, Mozilla Foundation and contributors All rights reserved. @@ -4648,69 +3898,6 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ----------- -The following NPM package may be included in this product: - - - sprintf-js@1.0.3 - -This package contains the following license and notice below: - -Copyright (c) 2007-2014, Alexandru Marasteanu -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: -* Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. -* Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. -* Neither the name of this software nor the names of its contributors may be - used to endorse or promote products derived from this software without - specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR -ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES -(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; -LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND -ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - ------------ - -The following NPM package may be included in this product: - - - string-argv@0.3.1 - -This package contains the following license and notice below: - -The MIT License (MIT) - -Copyright 2014 Anthony McCormick - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. - ------------ - The following NPM package may be included in this product: - supercluster@7.1.5 @@ -4795,36 +3982,6 @@ SOFTWARE. ----------- -The following NPM package may be included in this product: - - - timsort@0.3.0 - -This package contains the following license and notice below: - -The MIT License - -Copyright (c) 2015 Marco Ziccardi - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. - ------------ - The following NPM package may be included in this product: - tiny-warning@1.0.3 @@ -4940,70 +4097,6 @@ PERFORMANCE OF THIS SOFTWARE. ----------- -The following NPM package may be included in this product: - - - typescript@4.5.5 - -This package contains the following license and notice below: - -Apache License - -Version 2.0, January 2004 - -http://www.apache.org/licenses/ - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -1. Definitions. - -"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. - -"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. - -"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. - -"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. - -"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. - -"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. - -"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). - -"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. - -"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." - -"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. - -2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. - -3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. - -4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: - -You must give any other recipients of the Work or Derivative Works a copy of this License; and - -You must cause any modified files to carry prominent notices stating that You changed the files; and - -You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and - -If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. - -5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. - -6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. - -7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. - -8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. - -9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. - -END OF TERMS AND CONDITIONS - ------------ - The following NPM package may be included in this product: - ulidx@2.1.0 @@ -5064,55 +4157,6 @@ SOFTWARE. ----------- -The following NPM package may be included in this product: - - - universalify@0.1.2 - -This package contains the following license and notice below: - -(The MIT License) - -Copyright (c) 2017, Ryan Zimmerman - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the 'Software'), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------ - -The following NPM package may be included in this product: - - - uri-js@4.4.1 - -This package contains the following license and notice below: - -Copyright 2011 Gary Court. All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - -THIS SOFTWARE IS PROVIDED BY GARY COURT "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARY COURT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of Gary Court. - ------------ - The following NPM package may be included in this product: - use-isomorphic-layout-effect@1.1.2 @@ -5176,35 +4220,6 @@ OTHER DEALINGS IN THE SOFTWARE. ----------- -The following NPM package may be included in this product: - - - validator@13.7.0 - -This package contains the following license and notice below: - -Copyright (c) 2018 Chris O'Hara - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------ - The following NPM package may be included in this product: - vt-pbf@3.1.3 @@ -5369,35 +4384,4 @@ THIS SOFTWARE. ----------- -The following NPM package may be included in this product: - - - z-schema@5.0.2 - -This package contains the following license and notice below: - -The MIT License (MIT) - -Copyright (c) 2014 Martin Zagora and other contributors -https://github.com/zaggino/z-schema/graphs/contributors - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. - ------------ - This file was generated with generate-license-file! https://www.npmjs.com/package/generate-license-file diff --git a/api-extractor.json b/api-extractor.json index dfdbe57ac..267419527 100644 --- a/api-extractor.json +++ b/api-extractor.json @@ -45,7 +45,7 @@ * * SUPPORTED TOKENS: , , */ - "mainEntryPointFilePath": "/lib/commonjs/index.d.ts", + "mainEntryPointFilePath": "/dist/index.d.ts", /** * A list of NPM package names whose exports should be treated as part of this package. @@ -221,7 +221,7 @@ * SUPPORTED TOKENS: , , * DEFAULT VALUE: "" */ - "publicTrimmedFilePath": "/lib/esm/index.d.ts" + "publicTrimmedFilePath": "/dist/index.d.ts" /** * When a declaration is trimmed, by default it will be replaced by a code comment such as diff --git a/docs/search-ui-react.alternativeverticals.md b/docs/search-ui-react.alternativeverticals.md index db36da2e7..d5593c294 100644 --- a/docs/search-ui-react.alternativeverticals.md +++ b/docs/search-ui-react.alternativeverticals.md @@ -6,7 +6,7 @@ A component that displays the alternative verticals that have results if a search returns none on the current vertical. -Signature: +**Signature:** ```typescript declare function AlternativeVerticals({ currentVerticalLabel, verticalConfigMap, displayAllOnNoResults, customCssClasses }: AlternativeVerticalsProps): JSX.Element | null; @@ -16,9 +16,9 @@ declare function AlternativeVerticals({ currentVerticalLabel, verticalConfigMap, | Parameter | Type | Description | | --- | --- | --- | -| { currentVerticalLabel, verticalConfigMap, displayAllOnNoResults, customCssClasses } | AlternativeVerticalsProps | | +| { currentVerticalLabel, verticalConfigMap, displayAllOnNoResults, customCssClasses } | [AlternativeVerticalsProps](./search-ui-react.alternativeverticalsprops.md) | | -Returns: +**Returns:** JSX.Element \| null diff --git a/docs/search-ui-react.alternativeverticalscssclasses.alternativeverticalscontainer.md b/docs/search-ui-react.alternativeverticalscssclasses.alternativeverticalscontainer.md index db7d2c05c..2b9d38a78 100644 --- a/docs/search-ui-react.alternativeverticalscssclasses.alternativeverticalscontainer.md +++ b/docs/search-ui-react.alternativeverticalscssclasses.alternativeverticalscontainer.md @@ -4,7 +4,7 @@ ## AlternativeVerticalsCssClasses.alternativeVerticalsContainer property -Signature: +**Signature:** ```typescript alternativeVerticalsContainer?: string; diff --git a/docs/search-ui-react.alternativeverticalscssclasses.alternativeverticalsloading.md b/docs/search-ui-react.alternativeverticalscssclasses.alternativeverticalsloading.md index 842d125b0..6a08653bb 100644 --- a/docs/search-ui-react.alternativeverticalscssclasses.alternativeverticalsloading.md +++ b/docs/search-ui-react.alternativeverticalscssclasses.alternativeverticalsloading.md @@ -4,7 +4,7 @@ ## AlternativeVerticalsCssClasses.alternativeVerticalsLoading property -Signature: +**Signature:** ```typescript alternativeVerticalsLoading?: string; diff --git a/docs/search-ui-react.alternativeverticalscssclasses.categoriestext.md b/docs/search-ui-react.alternativeverticalscssclasses.categoriestext.md index 77113924a..43025d17f 100644 --- a/docs/search-ui-react.alternativeverticalscssclasses.categoriestext.md +++ b/docs/search-ui-react.alternativeverticalscssclasses.categoriestext.md @@ -4,7 +4,7 @@ ## AlternativeVerticalsCssClasses.categoriesText property -Signature: +**Signature:** ```typescript categoriesText?: string; diff --git a/docs/search-ui-react.alternativeverticalscssclasses.md b/docs/search-ui-react.alternativeverticalscssclasses.md index 276700f06..d83e336ad 100644 --- a/docs/search-ui-react.alternativeverticalscssclasses.md +++ b/docs/search-ui-react.alternativeverticalscssclasses.md @@ -6,7 +6,7 @@ The CSS class interface used for [AlternativeVerticals()](./search-ui-react.alternativeverticals.md). -Signature: +**Signature:** ```typescript interface AlternativeVerticalsCssClasses @@ -14,12 +14,12 @@ interface AlternativeVerticalsCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [alternativeVerticalsContainer?](./search-ui-react.alternativeverticalscssclasses.alternativeverticalscontainer.md) | string | (Optional) | -| [alternativeVerticalsLoading?](./search-ui-react.alternativeverticalscssclasses.alternativeverticalsloading.md) | string | (Optional) | -| [categoriesText?](./search-ui-react.alternativeverticalscssclasses.categoriestext.md) | string | (Optional) | -| [noResultsText?](./search-ui-react.alternativeverticalscssclasses.noresultstext.md) | string | (Optional) | -| [suggestion?](./search-ui-react.alternativeverticalscssclasses.suggestion.md) | string | (Optional) | -| [verticalIcon?](./search-ui-react.alternativeverticalscssclasses.verticalicon.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [alternativeVerticalsContainer?](./search-ui-react.alternativeverticalscssclasses.alternativeverticalscontainer.md) | | string | _(Optional)_ | +| [alternativeVerticalsLoading?](./search-ui-react.alternativeverticalscssclasses.alternativeverticalsloading.md) | | string | _(Optional)_ | +| [categoriesText?](./search-ui-react.alternativeverticalscssclasses.categoriestext.md) | | string | _(Optional)_ | +| [noResultsText?](./search-ui-react.alternativeverticalscssclasses.noresultstext.md) | | string | _(Optional)_ | +| [suggestion?](./search-ui-react.alternativeverticalscssclasses.suggestion.md) | | string | _(Optional)_ | +| [verticalIcon?](./search-ui-react.alternativeverticalscssclasses.verticalicon.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.alternativeverticalscssclasses.noresultstext.md b/docs/search-ui-react.alternativeverticalscssclasses.noresultstext.md index 51a253e1c..7ee2b8e08 100644 --- a/docs/search-ui-react.alternativeverticalscssclasses.noresultstext.md +++ b/docs/search-ui-react.alternativeverticalscssclasses.noresultstext.md @@ -4,7 +4,7 @@ ## AlternativeVerticalsCssClasses.noResultsText property -Signature: +**Signature:** ```typescript noResultsText?: string; diff --git a/docs/search-ui-react.alternativeverticalscssclasses.suggestion.md b/docs/search-ui-react.alternativeverticalscssclasses.suggestion.md index e2a9af57d..7920be905 100644 --- a/docs/search-ui-react.alternativeverticalscssclasses.suggestion.md +++ b/docs/search-ui-react.alternativeverticalscssclasses.suggestion.md @@ -4,7 +4,7 @@ ## AlternativeVerticalsCssClasses.suggestion property -Signature: +**Signature:** ```typescript suggestion?: string; diff --git a/docs/search-ui-react.alternativeverticalscssclasses.verticalicon.md b/docs/search-ui-react.alternativeverticalscssclasses.verticalicon.md index 4ac779f75..8a4c72df2 100644 --- a/docs/search-ui-react.alternativeverticalscssclasses.verticalicon.md +++ b/docs/search-ui-react.alternativeverticalscssclasses.verticalicon.md @@ -4,7 +4,7 @@ ## AlternativeVerticalsCssClasses.verticalIcon property -Signature: +**Signature:** ```typescript verticalIcon?: string; diff --git a/docs/search-ui-react.alternativeverticalsprops.currentverticallabel.md b/docs/search-ui-react.alternativeverticalsprops.currentverticallabel.md index af79950e0..991d704c9 100644 --- a/docs/search-ui-react.alternativeverticalsprops.currentverticallabel.md +++ b/docs/search-ui-react.alternativeverticalsprops.currentverticallabel.md @@ -6,7 +6,7 @@ The label for the current vertical. -Signature: +**Signature:** ```typescript currentVerticalLabel: string; diff --git a/docs/search-ui-react.alternativeverticalsprops.customcssclasses.md b/docs/search-ui-react.alternativeverticalsprops.customcssclasses.md index f60eb03e6..1bd8b5029 100644 --- a/docs/search-ui-react.alternativeverticalsprops.customcssclasses.md +++ b/docs/search-ui-react.alternativeverticalsprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: AlternativeVerticalsCssClasses; diff --git a/docs/search-ui-react.alternativeverticalsprops.displayallonnoresults.md b/docs/search-ui-react.alternativeverticalsprops.displayallonnoresults.md index 173b6a2e7..d83189c0e 100644 --- a/docs/search-ui-react.alternativeverticalsprops.displayallonnoresults.md +++ b/docs/search-ui-react.alternativeverticalsprops.displayallonnoresults.md @@ -6,7 +6,7 @@ Whether or not all results should be displayed when there are none returned from the search. Defaults to true. -Signature: +**Signature:** ```typescript displayAllOnNoResults?: boolean; diff --git a/docs/search-ui-react.alternativeverticalsprops.md b/docs/search-ui-react.alternativeverticalsprops.md index f6d46c27d..19a3bf6d3 100644 --- a/docs/search-ui-react.alternativeverticalsprops.md +++ b/docs/search-ui-react.alternativeverticalsprops.md @@ -6,7 +6,7 @@ Props for [AlternativeVerticals()](./search-ui-react.alternativeverticals.md). -Signature: +**Signature:** ```typescript interface AlternativeVerticalsProps @@ -14,10 +14,10 @@ interface AlternativeVerticalsProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [currentVerticalLabel](./search-ui-react.alternativeverticalsprops.currentverticallabel.md) | string | The label for the current vertical. | -| [customCssClasses?](./search-ui-react.alternativeverticalsprops.customcssclasses.md) | AlternativeVerticalsCssClasses | (Optional) CSS classes for customizing the component styling. | -| [displayAllOnNoResults?](./search-ui-react.alternativeverticalsprops.displayallonnoresults.md) | boolean | (Optional) Whether or not all results should be displayed when there are none returned from the search. Defaults to true. | -| [verticalConfigMap](./search-ui-react.alternativeverticalsprops.verticalconfigmap.md) | VerticalLabelMap | A map of verticalKeys to the display label for that vertical. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [currentVerticalLabel](./search-ui-react.alternativeverticalsprops.currentverticallabel.md) | | string | The label for the current vertical. | +| [customCssClasses?](./search-ui-react.alternativeverticalsprops.customcssclasses.md) | | [AlternativeVerticalsCssClasses](./search-ui-react.alternativeverticalscssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [displayAllOnNoResults?](./search-ui-react.alternativeverticalsprops.displayallonnoresults.md) | | boolean | _(Optional)_ Whether or not all results should be displayed when there are none returned from the search. Defaults to true. | +| [verticalConfigMap](./search-ui-react.alternativeverticalsprops.verticalconfigmap.md) | | [VerticalLabelMap](./search-ui-react.verticallabelmap.md) | A map of verticalKeys to the display label for that vertical. | diff --git a/docs/search-ui-react.alternativeverticalsprops.verticalconfigmap.md b/docs/search-ui-react.alternativeverticalsprops.verticalconfigmap.md index de0bb0a6b..ce945fde1 100644 --- a/docs/search-ui-react.alternativeverticalsprops.verticalconfigmap.md +++ b/docs/search-ui-react.alternativeverticalsprops.verticalconfigmap.md @@ -6,7 +6,7 @@ A map of verticalKeys to the display label for that vertical. -Signature: +**Signature:** ```typescript verticalConfigMap: VerticalLabelMap; diff --git a/docs/search-ui-react.analyticsprovider.md b/docs/search-ui-react.analyticsprovider.md index 01be897ba..c11ec75cc 100644 --- a/docs/search-ui-react.analyticsprovider.md +++ b/docs/search-ui-react.analyticsprovider.md @@ -6,7 +6,7 @@ A higher-order component which provides analytics for its children. -Signature: +**Signature:** ```typescript declare function AnalyticsProvider(props: PropsWithChildren): JSX.Element; @@ -18,7 +18,7 @@ declare function AnalyticsProvider(props: PropsWithChildren): J | --- | --- | --- | | props | PropsWithChildren<AnalyticsConfig> | The configuration for the analytics service | -Returns: +**Returns:** JSX.Element diff --git a/docs/search-ui-react.appliedfilters.md b/docs/search-ui-react.appliedfilters.md index 7267cd08e..9a2273a56 100644 --- a/docs/search-ui-react.appliedfilters.md +++ b/docs/search-ui-react.appliedfilters.md @@ -6,7 +6,7 @@ A component that displays a list of filters applied to the current vertical search, which may include any selected options from facets, NLP filters, and field value static filters. -Signature: +**Signature:** ```typescript declare function AppliedFilters(props: AppliedFiltersProps): JSX.Element; @@ -16,9 +16,9 @@ declare function AppliedFilters(props: AppliedFiltersProps): JSX.Element; | Parameter | Type | Description | | --- | --- | --- | -| props | AppliedFiltersProps | [AppliedFiltersProps](./search-ui-react.appliedfiltersprops.md) | +| props | [AppliedFiltersProps](./search-ui-react.appliedfiltersprops.md) | [AppliedFiltersProps](./search-ui-react.appliedfiltersprops.md) | -Returns: +**Returns:** JSX.Element diff --git a/docs/search-ui-react.appliedfilterscssclasses.appliedfilterscontainer.md b/docs/search-ui-react.appliedfilterscssclasses.appliedfilterscontainer.md index 076a9abfa..632201976 100644 --- a/docs/search-ui-react.appliedfilterscssclasses.appliedfilterscontainer.md +++ b/docs/search-ui-react.appliedfilterscssclasses.appliedfilterscontainer.md @@ -4,7 +4,7 @@ ## AppliedFiltersCssClasses.appliedFiltersContainer property -Signature: +**Signature:** ```typescript appliedFiltersContainer?: string; diff --git a/docs/search-ui-react.appliedfilterscssclasses.appliedfiltersloading.md b/docs/search-ui-react.appliedfilterscssclasses.appliedfiltersloading.md index 42c51ed67..002122d2b 100644 --- a/docs/search-ui-react.appliedfilterscssclasses.appliedfiltersloading.md +++ b/docs/search-ui-react.appliedfilterscssclasses.appliedfiltersloading.md @@ -4,7 +4,7 @@ ## AppliedFiltersCssClasses.appliedFiltersLoading property -Signature: +**Signature:** ```typescript appliedFiltersLoading?: string; diff --git a/docs/search-ui-react.appliedfilterscssclasses.clearallbutton.md b/docs/search-ui-react.appliedfilterscssclasses.clearallbutton.md index cb7558fa4..321760a74 100644 --- a/docs/search-ui-react.appliedfilterscssclasses.clearallbutton.md +++ b/docs/search-ui-react.appliedfilterscssclasses.clearallbutton.md @@ -4,7 +4,7 @@ ## AppliedFiltersCssClasses.clearAllButton property -Signature: +**Signature:** ```typescript clearAllButton?: string; diff --git a/docs/search-ui-react.appliedfilterscssclasses.filterlabel.md b/docs/search-ui-react.appliedfilterscssclasses.filterlabel.md index e1a063686..a2e68f70f 100644 --- a/docs/search-ui-react.appliedfilterscssclasses.filterlabel.md +++ b/docs/search-ui-react.appliedfilterscssclasses.filterlabel.md @@ -4,7 +4,7 @@ ## AppliedFiltersCssClasses.filterLabel property -Signature: +**Signature:** ```typescript filterLabel?: string; diff --git a/docs/search-ui-react.appliedfilterscssclasses.md b/docs/search-ui-react.appliedfilterscssclasses.md index ff0fa2000..bd5d47d44 100644 --- a/docs/search-ui-react.appliedfilterscssclasses.md +++ b/docs/search-ui-react.appliedfilterscssclasses.md @@ -6,7 +6,7 @@ The CSS class interface used for [AppliedFilters()](./search-ui-react.appliedfilters.md). -Signature: +**Signature:** ```typescript interface AppliedFiltersCssClasses @@ -14,12 +14,12 @@ interface AppliedFiltersCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [appliedFiltersContainer?](./search-ui-react.appliedfilterscssclasses.appliedfilterscontainer.md) | string | (Optional) | -| [appliedFiltersLoading?](./search-ui-react.appliedfilterscssclasses.appliedfiltersloading.md) | string | (Optional) | -| [clearAllButton?](./search-ui-react.appliedfilterscssclasses.clearallbutton.md) | string | (Optional) | -| [filterLabel?](./search-ui-react.appliedfilterscssclasses.filterlabel.md) | string | (Optional) | -| [nlpFilter?](./search-ui-react.appliedfilterscssclasses.nlpfilter.md) | string | (Optional) | -| [removableFilter?](./search-ui-react.appliedfilterscssclasses.removablefilter.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [appliedFiltersContainer?](./search-ui-react.appliedfilterscssclasses.appliedfilterscontainer.md) | | string | _(Optional)_ | +| [appliedFiltersLoading?](./search-ui-react.appliedfilterscssclasses.appliedfiltersloading.md) | | string | _(Optional)_ | +| [clearAllButton?](./search-ui-react.appliedfilterscssclasses.clearallbutton.md) | | string | _(Optional)_ | +| [filterLabel?](./search-ui-react.appliedfilterscssclasses.filterlabel.md) | | string | _(Optional)_ | +| [nlpFilter?](./search-ui-react.appliedfilterscssclasses.nlpfilter.md) | | string | _(Optional)_ | +| [removableFilter?](./search-ui-react.appliedfilterscssclasses.removablefilter.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.appliedfilterscssclasses.nlpfilter.md b/docs/search-ui-react.appliedfilterscssclasses.nlpfilter.md index 151cab219..bbf29afe2 100644 --- a/docs/search-ui-react.appliedfilterscssclasses.nlpfilter.md +++ b/docs/search-ui-react.appliedfilterscssclasses.nlpfilter.md @@ -4,7 +4,7 @@ ## AppliedFiltersCssClasses.nlpFilter property -Signature: +**Signature:** ```typescript nlpFilter?: string; diff --git a/docs/search-ui-react.appliedfilterscssclasses.removablefilter.md b/docs/search-ui-react.appliedfilterscssclasses.removablefilter.md index d9e74fb4c..5d9d69b29 100644 --- a/docs/search-ui-react.appliedfilterscssclasses.removablefilter.md +++ b/docs/search-ui-react.appliedfilterscssclasses.removablefilter.md @@ -4,7 +4,7 @@ ## AppliedFiltersCssClasses.removableFilter property -Signature: +**Signature:** ```typescript removableFilter?: string; diff --git a/docs/search-ui-react.appliedfiltersprops.customcssclasses.md b/docs/search-ui-react.appliedfiltersprops.customcssclasses.md index ac503ef73..1cb879700 100644 --- a/docs/search-ui-react.appliedfiltersprops.customcssclasses.md +++ b/docs/search-ui-react.appliedfiltersprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: AppliedFiltersCssClasses; diff --git a/docs/search-ui-react.appliedfiltersprops.hiddenfields.md b/docs/search-ui-react.appliedfiltersprops.hiddenfields.md index 888c9a773..1ddf0a06d 100644 --- a/docs/search-ui-react.appliedfiltersprops.hiddenfields.md +++ b/docs/search-ui-react.appliedfiltersprops.hiddenfields.md @@ -6,7 +6,7 @@ List of filters that should not be displayed. By default, builtin.entityType will be hidden. -Signature: +**Signature:** ```typescript hiddenFields?: string[]; diff --git a/docs/search-ui-react.appliedfiltersprops.hierarchicalfacetsdelimiter.md b/docs/search-ui-react.appliedfiltersprops.hierarchicalfacetsdelimiter.md index 56846db81..547045c50 100644 --- a/docs/search-ui-react.appliedfiltersprops.hierarchicalfacetsdelimiter.md +++ b/docs/search-ui-react.appliedfiltersprops.hierarchicalfacetsdelimiter.md @@ -6,7 +6,7 @@ The delimiter for determining facet hierarchies, defaults to ">". -Signature: +**Signature:** ```typescript hierarchicalFacetsDelimiter?: string; diff --git a/docs/search-ui-react.appliedfiltersprops.hierarchicalfacetsfieldids.md b/docs/search-ui-react.appliedfiltersprops.hierarchicalfacetsfieldids.md index 04a3d480a..10be81411 100644 --- a/docs/search-ui-react.appliedfiltersprops.hierarchicalfacetsfieldids.md +++ b/docs/search-ui-react.appliedfiltersprops.hierarchicalfacetsfieldids.md @@ -6,7 +6,7 @@ A set of facet fieldIds that should be interpreted as "hierarchical". -Signature: +**Signature:** ```typescript hierarchicalFacetsFieldIds?: string[]; diff --git a/docs/search-ui-react.appliedfiltersprops.md b/docs/search-ui-react.appliedfiltersprops.md index c30dec8f0..d8cabc1e6 100644 --- a/docs/search-ui-react.appliedfiltersprops.md +++ b/docs/search-ui-react.appliedfiltersprops.md @@ -6,7 +6,7 @@ Properties for [AppliedFilters()](./search-ui-react.appliedfilters.md). -Signature: +**Signature:** ```typescript interface AppliedFiltersProps @@ -14,10 +14,10 @@ interface AppliedFiltersProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.appliedfiltersprops.customcssclasses.md) | AppliedFiltersCssClasses | (Optional) CSS classes for customizing the component styling. | -| [hiddenFields?](./search-ui-react.appliedfiltersprops.hiddenfields.md) | string\[\] | (Optional) List of filters that should not be displayed. By default, builtin.entityType will be hidden. | -| [hierarchicalFacetsDelimiter?](./search-ui-react.appliedfiltersprops.hierarchicalfacetsdelimiter.md) | string | (Optional) The delimiter for determining facet hierarchies, defaults to ">". | -| [hierarchicalFacetsFieldIds?](./search-ui-react.appliedfiltersprops.hierarchicalfacetsfieldids.md) | string\[\] | (Optional) A set of facet fieldIds that should be interpreted as "hierarchical". | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.appliedfiltersprops.customcssclasses.md) | | [AppliedFiltersCssClasses](./search-ui-react.appliedfilterscssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [hiddenFields?](./search-ui-react.appliedfiltersprops.hiddenfields.md) | | string\[\] | _(Optional)_ List of filters that should not be displayed. By default, builtin.entityType will be hidden. | +| [hierarchicalFacetsDelimiter?](./search-ui-react.appliedfiltersprops.hierarchicalfacetsdelimiter.md) | | string | _(Optional)_ The delimiter for determining facet hierarchies, defaults to ">". | +| [hierarchicalFacetsFieldIds?](./search-ui-react.appliedfiltersprops.hierarchicalfacetsfieldids.md) | | string\[\] | _(Optional)_ A set of facet fieldIds that should be interpreted as "hierarchical". | diff --git a/docs/search-ui-react.applyfiltersbutton.md b/docs/search-ui-react.applyfiltersbutton.md index da219f1a2..abd231b84 100644 --- a/docs/search-ui-react.applyfiltersbutton.md +++ b/docs/search-ui-react.applyfiltersbutton.md @@ -6,7 +6,7 @@ Runs a vertical search. By default has `position: sticky` styling that anchors it to the bottom of the page. -Signature: +**Signature:** ```typescript declare function ApplyFiltersButton({ customCssClasses, label }: ApplyFiltersButtonProps): JSX.Element; @@ -16,9 +16,9 @@ declare function ApplyFiltersButton({ customCssClasses, label }: ApplyFiltersBut | Parameter | Type | Description | | --- | --- | --- | -| { customCssClasses, label } | ApplyFiltersButtonProps | | +| { customCssClasses, label } | [ApplyFiltersButtonProps](./search-ui-react.applyfiltersbuttonprops.md) | | -Returns: +**Returns:** JSX.Element diff --git a/docs/search-ui-react.applyfiltersbuttoncssclasses.button.md b/docs/search-ui-react.applyfiltersbuttoncssclasses.button.md index 1ccc30c8e..873b750fd 100644 --- a/docs/search-ui-react.applyfiltersbuttoncssclasses.button.md +++ b/docs/search-ui-react.applyfiltersbuttoncssclasses.button.md @@ -4,7 +4,7 @@ ## ApplyFiltersButtonCssClasses.button property -Signature: +**Signature:** ```typescript button?: string; diff --git a/docs/search-ui-react.applyfiltersbuttoncssclasses.md b/docs/search-ui-react.applyfiltersbuttoncssclasses.md index da83beeef..4af756a9e 100644 --- a/docs/search-ui-react.applyfiltersbuttoncssclasses.md +++ b/docs/search-ui-react.applyfiltersbuttoncssclasses.md @@ -6,7 +6,7 @@ The CSS class interface for [ApplyFiltersButtonProps](./search-ui-react.applyfiltersbuttonprops.md). -Signature: +**Signature:** ```typescript interface ApplyFiltersButtonCssClasses @@ -14,7 +14,7 @@ interface ApplyFiltersButtonCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [button?](./search-ui-react.applyfiltersbuttoncssclasses.button.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [button?](./search-ui-react.applyfiltersbuttoncssclasses.button.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.applyfiltersbuttonprops.customcssclasses.md b/docs/search-ui-react.applyfiltersbuttonprops.customcssclasses.md index f0c1ed039..557f96578 100644 --- a/docs/search-ui-react.applyfiltersbuttonprops.customcssclasses.md +++ b/docs/search-ui-react.applyfiltersbuttonprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: ApplyFiltersButtonCssClasses; diff --git a/docs/search-ui-react.applyfiltersbuttonprops.label.md b/docs/search-ui-react.applyfiltersbuttonprops.label.md index 602202327..3f1d8eb8d 100644 --- a/docs/search-ui-react.applyfiltersbuttonprops.label.md +++ b/docs/search-ui-react.applyfiltersbuttonprops.label.md @@ -6,7 +6,7 @@ The label for the button, defaults to 'Apply Filters' -Signature: +**Signature:** ```typescript label?: string; diff --git a/docs/search-ui-react.applyfiltersbuttonprops.md b/docs/search-ui-react.applyfiltersbuttonprops.md index bdc14f0f0..e3d259464 100644 --- a/docs/search-ui-react.applyfiltersbuttonprops.md +++ b/docs/search-ui-react.applyfiltersbuttonprops.md @@ -6,7 +6,7 @@ Props for [ApplyFiltersButton()](./search-ui-react.applyfiltersbutton.md) -Signature: +**Signature:** ```typescript interface ApplyFiltersButtonProps @@ -14,8 +14,8 @@ interface ApplyFiltersButtonProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.applyfiltersbuttonprops.customcssclasses.md) | ApplyFiltersButtonCssClasses | (Optional) CSS classes for customizing the component styling. | -| [label?](./search-ui-react.applyfiltersbuttonprops.label.md) | string | (Optional) The label for the button, defaults to 'Apply Filters' | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.applyfiltersbuttonprops.customcssclasses.md) | | [ApplyFiltersButtonCssClasses](./search-ui-react.applyfiltersbuttoncssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [label?](./search-ui-react.applyfiltersbuttonprops.label.md) | | string | _(Optional)_ The label for the button, defaults to 'Apply Filters' | diff --git a/docs/search-ui-react.autocompleteresultcssclasses.highlighted.md b/docs/search-ui-react.autocompleteresultcssclasses.highlighted.md index 2658531e7..924a777fa 100644 --- a/docs/search-ui-react.autocompleteresultcssclasses.highlighted.md +++ b/docs/search-ui-react.autocompleteresultcssclasses.highlighted.md @@ -4,7 +4,7 @@ ## AutocompleteResultCssClasses.highlighted property -Signature: +**Signature:** ```typescript highlighted?: string; diff --git a/docs/search-ui-react.autocompleteresultcssclasses.icon.md b/docs/search-ui-react.autocompleteresultcssclasses.icon.md index 6d60e72b7..cb90f9841 100644 --- a/docs/search-ui-react.autocompleteresultcssclasses.icon.md +++ b/docs/search-ui-react.autocompleteresultcssclasses.icon.md @@ -4,7 +4,7 @@ ## AutocompleteResultCssClasses.icon property -Signature: +**Signature:** ```typescript icon?: string; diff --git a/docs/search-ui-react.autocompleteresultcssclasses.md b/docs/search-ui-react.autocompleteresultcssclasses.md index 5d2a4777c..97dc3cbe9 100644 --- a/docs/search-ui-react.autocompleteresultcssclasses.md +++ b/docs/search-ui-react.autocompleteresultcssclasses.md @@ -6,7 +6,7 @@ The CSS class interface for the Autocomplete Result. -Signature: +**Signature:** ```typescript interface AutocompleteResultCssClasses @@ -14,10 +14,10 @@ interface AutocompleteResultCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [highlighted?](./search-ui-react.autocompleteresultcssclasses.highlighted.md) | string | (Optional) | -| [icon?](./search-ui-react.autocompleteresultcssclasses.icon.md) | string | (Optional) | -| [nonHighlighted?](./search-ui-react.autocompleteresultcssclasses.nonhighlighted.md) | string | (Optional) | -| [option?](./search-ui-react.autocompleteresultcssclasses.option.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [highlighted?](./search-ui-react.autocompleteresultcssclasses.highlighted.md) | | string | _(Optional)_ | +| [icon?](./search-ui-react.autocompleteresultcssclasses.icon.md) | | string | _(Optional)_ | +| [nonHighlighted?](./search-ui-react.autocompleteresultcssclasses.nonhighlighted.md) | | string | _(Optional)_ | +| [option?](./search-ui-react.autocompleteresultcssclasses.option.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.autocompleteresultcssclasses.nonhighlighted.md b/docs/search-ui-react.autocompleteresultcssclasses.nonhighlighted.md index 0d13130cf..877c93393 100644 --- a/docs/search-ui-react.autocompleteresultcssclasses.nonhighlighted.md +++ b/docs/search-ui-react.autocompleteresultcssclasses.nonhighlighted.md @@ -4,7 +4,7 @@ ## AutocompleteResultCssClasses.nonHighlighted property -Signature: +**Signature:** ```typescript nonHighlighted?: string; diff --git a/docs/search-ui-react.autocompleteresultcssclasses.option.md b/docs/search-ui-react.autocompleteresultcssclasses.option.md index 46b9b9fb5..0dd78248b 100644 --- a/docs/search-ui-react.autocompleteresultcssclasses.option.md +++ b/docs/search-ui-react.autocompleteresultcssclasses.option.md @@ -4,7 +4,7 @@ ## AutocompleteResultCssClasses.option property -Signature: +**Signature:** ```typescript option?: string; diff --git a/docs/search-ui-react.cardanalyticsdatatype.md b/docs/search-ui-react.cardanalyticsdatatype.md index e713fb31e..314103e0d 100644 --- a/docs/search-ui-react.cardanalyticsdatatype.md +++ b/docs/search-ui-react.cardanalyticsdatatype.md @@ -6,8 +6,10 @@ The data types use to construct the payload in the analytics event. -Signature: +**Signature:** ```typescript type CardAnalyticsDataType = DirectAnswer$1 | Result; ``` +**References:** [DefaultRawDataType](./search-ui-react.defaultrawdatatype.md) + diff --git a/docs/search-ui-react.cardanalyticstype.md b/docs/search-ui-react.cardanalyticstype.md index 6fa1932c6..a2afadcdf 100644 --- a/docs/search-ui-react.cardanalyticstype.md +++ b/docs/search-ui-react.cardanalyticstype.md @@ -6,8 +6,10 @@ Analytics event types for interactions on a card. -Signature: +**Signature:** ```typescript type CardAnalyticsType = CardCtaEventType | FeedbackType; ``` +**References:** [CardCtaEventType](./search-ui-react.cardctaeventtype.md), [FeedbackType](./search-ui-react.feedbacktype.md) + diff --git a/docs/search-ui-react.cardcomponent.md b/docs/search-ui-react.cardcomponent.md index a54f51de8..155a4e213 100644 --- a/docs/search-ui-react.cardcomponent.md +++ b/docs/search-ui-react.cardcomponent.md @@ -6,8 +6,10 @@ A functional component that can be used to render a result card. -Signature: +**Signature:** ```typescript type CardComponent = (props: CardProps) => JSX.Element; ``` +**References:** [DefaultRawDataType](./search-ui-react.defaultrawdatatype.md), [CardProps](./search-ui-react.cardprops.md) + diff --git a/docs/search-ui-react.cardctaeventtype.md b/docs/search-ui-react.cardctaeventtype.md index a0a924059..5c5c45f66 100644 --- a/docs/search-ui-react.cardctaeventtype.md +++ b/docs/search-ui-react.cardctaeventtype.md @@ -6,7 +6,7 @@ Analytics event types for cta click and title click. -Signature: +**Signature:** ```typescript type CardCtaEventType = 'CTA_CLICK' | 'TITLE_CLICK'; diff --git a/docs/search-ui-react.cardprops.md b/docs/search-ui-react.cardprops.md index 2a6e8ce8f..ebfa42f25 100644 --- a/docs/search-ui-react.cardprops.md +++ b/docs/search-ui-react.cardprops.md @@ -6,7 +6,7 @@ The props provided to every [CardComponent](./search-ui-react.cardcomponent.md). -Signature: +**Signature:** ```typescript interface CardProps @@ -14,7 +14,7 @@ interface CardProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [result](./search-ui-react.cardprops.result.md) | Result<T> | The result data provided to the card for rendering. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [result](./search-ui-react.cardprops.result.md) | | Result<T> | The result data provided to the card for rendering. | diff --git a/docs/search-ui-react.cardprops.result.md b/docs/search-ui-react.cardprops.result.md index b716baebf..3a3b09205 100644 --- a/docs/search-ui-react.cardprops.result.md +++ b/docs/search-ui-react.cardprops.result.md @@ -6,7 +6,7 @@ The result data provided to the card for rendering. -Signature: +**Signature:** ```typescript result: Result; diff --git a/docs/search-ui-react.componentscontentpath.md b/docs/search-ui-react.componentscontentpath.md index a4b186db6..b2cb25c9d 100644 --- a/docs/search-ui-react.componentscontentpath.md +++ b/docs/search-ui-react.componentscontentpath.md @@ -6,7 +6,7 @@ Content path to the source files in component library that utilizes Tailwind class names. This is intended to be used in user's custom tailwind config. -Signature: +**Signature:** ```typescript ComponentsContentPath = "node_modules/@yext/search-ui-react/lib/**/*.{js,jsx}" diff --git a/docs/search-ui-react.coordinate.latitude.md b/docs/search-ui-react.coordinate.latitude.md index 01609f19c..430af38f4 100644 --- a/docs/search-ui-react.coordinate.latitude.md +++ b/docs/search-ui-react.coordinate.latitude.md @@ -6,7 +6,7 @@ The latitude of the location. -Signature: +**Signature:** ```typescript latitude: number; diff --git a/docs/search-ui-react.coordinate.longitude.md b/docs/search-ui-react.coordinate.longitude.md index 898032e64..c4c194eb3 100644 --- a/docs/search-ui-react.coordinate.longitude.md +++ b/docs/search-ui-react.coordinate.longitude.md @@ -6,7 +6,7 @@ The longitude of the location. -Signature: +**Signature:** ```typescript longitude: number; diff --git a/docs/search-ui-react.coordinate.md b/docs/search-ui-react.coordinate.md index 16b161142..5ca60b557 100644 --- a/docs/search-ui-react.coordinate.md +++ b/docs/search-ui-react.coordinate.md @@ -6,7 +6,7 @@ Coordinate use to represent the result's location on a map. -Signature: +**Signature:** ```typescript interface Coordinate @@ -14,8 +14,8 @@ interface Coordinate ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [latitude](./search-ui-react.coordinate.latitude.md) | number | The latitude of the location. | -| [longitude](./search-ui-react.coordinate.longitude.md) | number | The longitude of the location. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [latitude](./search-ui-react.coordinate.latitude.md) | | number | The latitude of the location. | +| [longitude](./search-ui-react.coordinate.longitude.md) | | number | The longitude of the location. | diff --git a/docs/search-ui-react.coordinategetter.md b/docs/search-ui-react.coordinategetter.md index 4531108a8..31d0362d6 100644 --- a/docs/search-ui-react.coordinategetter.md +++ b/docs/search-ui-react.coordinategetter.md @@ -6,8 +6,10 @@ A function use to derive a result's coordinate. -Signature: +**Signature:** ```typescript type CoordinateGetter = (result: Result) => Coordinate | undefined; ``` +**References:** [Coordinate](./search-ui-react.coordinate.md) + diff --git a/docs/search-ui-react.ctadata.label.md b/docs/search-ui-react.ctadata.label.md index a10a4d45f..fe0a6fb0c 100644 --- a/docs/search-ui-react.ctadata.label.md +++ b/docs/search-ui-react.ctadata.label.md @@ -6,7 +6,7 @@ The display label for the CTA element. -Signature: +**Signature:** ```typescript label: string; diff --git a/docs/search-ui-react.ctadata.link.md b/docs/search-ui-react.ctadata.link.md index 368625ec4..c7fe60e4e 100644 --- a/docs/search-ui-react.ctadata.link.md +++ b/docs/search-ui-react.ctadata.link.md @@ -6,7 +6,7 @@ The CTA link source. -Signature: +**Signature:** ```typescript link: string; diff --git a/docs/search-ui-react.ctadata.linktype.md b/docs/search-ui-react.ctadata.linktype.md index 608fc1d2b..f65f7bbf8 100644 --- a/docs/search-ui-react.ctadata.linktype.md +++ b/docs/search-ui-react.ctadata.linktype.md @@ -6,7 +6,7 @@ The CTA link type (e.g. URL, Phone, Email, Other). -Signature: +**Signature:** ```typescript linkType: string; diff --git a/docs/search-ui-react.ctadata.md b/docs/search-ui-react.ctadata.md index 10b06d6a8..d27101e89 100644 --- a/docs/search-ui-react.ctadata.md +++ b/docs/search-ui-react.ctadata.md @@ -6,7 +6,7 @@ The shape of a StandardCard CTA field's data. -Signature: +**Signature:** ```typescript interface CtaData @@ -14,9 +14,9 @@ interface CtaData ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [label](./search-ui-react.ctadata.label.md) | string | The display label for the CTA element. | -| [link](./search-ui-react.ctadata.link.md) | string | The CTA link source. | -| [linkType](./search-ui-react.ctadata.linktype.md) | string | The CTA link type (e.g. URL, Phone, Email, Other). | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [label](./search-ui-react.ctadata.label.md) | | string | The display label for the CTA element. | +| [link](./search-ui-react.ctadata.link.md) | | string | The CTA link source. | +| [linkType](./search-ui-react.ctadata.linktype.md) | | string | The CTA link type (e.g. URL, Phone, Email, Other). | diff --git a/docs/search-ui-react.defaultrawdatatype.md b/docs/search-ui-react.defaultrawdatatype.md index f176f799b..3a3bb7e7d 100644 --- a/docs/search-ui-react.defaultrawdatatype.md +++ b/docs/search-ui-react.defaultrawdatatype.md @@ -6,7 +6,7 @@ The default type for "rawData" field of type Result. -Signature: +**Signature:** ```typescript type DefaultRawDataType = Record; diff --git a/docs/search-ui-react.directanswer.md b/docs/search-ui-react.directanswer.md index 04addbb7e..a8d6e7d6e 100644 --- a/docs/search-ui-react.directanswer.md +++ b/docs/search-ui-react.directanswer.md @@ -6,7 +6,7 @@ Renders Direct Answers provided by the Search API. -Signature: +**Signature:** ```typescript declare function DirectAnswer({ customCssClasses, UnknownFieldTypeDisplay }: DirectAnswerProps): JSX.Element | null; @@ -16,9 +16,9 @@ declare function DirectAnswer({ customCssClasses, UnknownFieldTypeDisplay }: Dir | Parameter | Type | Description | | --- | --- | --- | -| { customCssClasses, UnknownFieldTypeDisplay } | DirectAnswerProps | | +| { customCssClasses, UnknownFieldTypeDisplay } | [DirectAnswerProps](./search-ui-react.directanswerprops.md) | | -Returns: +**Returns:** JSX.Element \| null diff --git a/docs/search-ui-react.directanswercssclasses.answer.md b/docs/search-ui-react.directanswercssclasses.answer.md index cc8e4ae59..48e396368 100644 --- a/docs/search-ui-react.directanswercssclasses.answer.md +++ b/docs/search-ui-react.directanswercssclasses.answer.md @@ -4,7 +4,7 @@ ## DirectAnswerCssClasses.answer property -Signature: +**Signature:** ```typescript answer?: string; diff --git a/docs/search-ui-react.directanswercssclasses.answercontainer.md b/docs/search-ui-react.directanswercssclasses.answercontainer.md index 657db4597..0ee954182 100644 --- a/docs/search-ui-react.directanswercssclasses.answercontainer.md +++ b/docs/search-ui-react.directanswercssclasses.answercontainer.md @@ -4,7 +4,7 @@ ## DirectAnswerCssClasses.answerContainer property -Signature: +**Signature:** ```typescript answerContainer?: string; diff --git a/docs/search-ui-react.directanswercssclasses.content.md b/docs/search-ui-react.directanswercssclasses.content.md index 32d530a16..896f8d906 100644 --- a/docs/search-ui-react.directanswercssclasses.content.md +++ b/docs/search-ui-react.directanswercssclasses.content.md @@ -4,7 +4,7 @@ ## DirectAnswerCssClasses.content property -Signature: +**Signature:** ```typescript content?: string; diff --git a/docs/search-ui-react.directanswercssclasses.description.md b/docs/search-ui-react.directanswercssclasses.description.md index 77a5341fd..df6d2c0ac 100644 --- a/docs/search-ui-react.directanswercssclasses.description.md +++ b/docs/search-ui-react.directanswercssclasses.description.md @@ -4,7 +4,7 @@ ## DirectAnswerCssClasses.description property -Signature: +**Signature:** ```typescript description?: string; diff --git a/docs/search-ui-react.directanswercssclasses.directanswercontainer.md b/docs/search-ui-react.directanswercssclasses.directanswercontainer.md index a0d2f45cd..db78a24c2 100644 --- a/docs/search-ui-react.directanswercssclasses.directanswercontainer.md +++ b/docs/search-ui-react.directanswercssclasses.directanswercontainer.md @@ -4,7 +4,7 @@ ## DirectAnswerCssClasses.directAnswerContainer property -Signature: +**Signature:** ```typescript directAnswerContainer?: string; diff --git a/docs/search-ui-react.directanswercssclasses.directanswerloading.md b/docs/search-ui-react.directanswercssclasses.directanswerloading.md index 3b38d6d2b..0f5c8cf3d 100644 --- a/docs/search-ui-react.directanswercssclasses.directanswerloading.md +++ b/docs/search-ui-react.directanswercssclasses.directanswerloading.md @@ -4,7 +4,7 @@ ## DirectAnswerCssClasses.directAnswerLoading property -Signature: +**Signature:** ```typescript directAnswerLoading?: string; diff --git a/docs/search-ui-react.directanswercssclasses.highlighted.md b/docs/search-ui-react.directanswercssclasses.highlighted.md index 8763a8f4e..3a9d72bf6 100644 --- a/docs/search-ui-react.directanswercssclasses.highlighted.md +++ b/docs/search-ui-react.directanswercssclasses.highlighted.md @@ -4,7 +4,7 @@ ## DirectAnswerCssClasses.highlighted property -Signature: +**Signature:** ```typescript highlighted?: string; diff --git a/docs/search-ui-react.directanswercssclasses.md b/docs/search-ui-react.directanswercssclasses.md index b7c719e3e..ef42c8d2d 100644 --- a/docs/search-ui-react.directanswercssclasses.md +++ b/docs/search-ui-react.directanswercssclasses.md @@ -6,22 +6,22 @@ The CSS class interface for [DirectAnswer()](./search-ui-react.directanswer.md). -Signature: +**Signature:** ```typescript interface DirectAnswerCssClasses extends ThumbsFeedbackCssClasses ``` -Extends: ThumbsFeedbackCssClasses +**Extends:** [ThumbsFeedbackCssClasses](./search-ui-react.thumbsfeedbackcssclasses.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [answer?](./search-ui-react.directanswercssclasses.answer.md) | string | (Optional) | -| [answerContainer?](./search-ui-react.directanswercssclasses.answercontainer.md) | string | (Optional) | -| [content?](./search-ui-react.directanswercssclasses.content.md) | string | (Optional) | -| [description?](./search-ui-react.directanswercssclasses.description.md) | string | (Optional) | -| [directAnswerContainer?](./search-ui-react.directanswercssclasses.directanswercontainer.md) | string | (Optional) | -| [directAnswerLoading?](./search-ui-react.directanswercssclasses.directanswerloading.md) | string | (Optional) | -| [highlighted?](./search-ui-react.directanswercssclasses.highlighted.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [answer?](./search-ui-react.directanswercssclasses.answer.md) | | string | _(Optional)_ | +| [answerContainer?](./search-ui-react.directanswercssclasses.answercontainer.md) | | string | _(Optional)_ | +| [content?](./search-ui-react.directanswercssclasses.content.md) | | string | _(Optional)_ | +| [description?](./search-ui-react.directanswercssclasses.description.md) | | string | _(Optional)_ | +| [directAnswerContainer?](./search-ui-react.directanswercssclasses.directanswercontainer.md) | | string | _(Optional)_ | +| [directAnswerLoading?](./search-ui-react.directanswercssclasses.directanswerloading.md) | | string | _(Optional)_ | +| [highlighted?](./search-ui-react.directanswercssclasses.highlighted.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.directanswerprops.customcssclasses.md b/docs/search-ui-react.directanswerprops.customcssclasses.md index 641238eb8..bb6b614ae 100644 --- a/docs/search-ui-react.directanswerprops.customcssclasses.md +++ b/docs/search-ui-react.directanswerprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: DirectAnswerCssClasses; diff --git a/docs/search-ui-react.directanswerprops.md b/docs/search-ui-react.directanswerprops.md index 0133f6507..55bc52819 100644 --- a/docs/search-ui-react.directanswerprops.md +++ b/docs/search-ui-react.directanswerprops.md @@ -6,7 +6,7 @@ Props for [DirectAnswer()](./search-ui-react.directanswer.md). -Signature: +**Signature:** ```typescript interface DirectAnswerProps @@ -14,8 +14,8 @@ interface DirectAnswerProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.directanswerprops.customcssclasses.md) | DirectAnswerCssClasses | (Optional) CSS classes for customizing the component styling. | -| [UnknownFieldTypeDisplay?](./search-ui-react.directanswerprops.unknownfieldtypedisplay.md) | UnknownFieldTypeDisplayComponent | (Optional) A component to handle rendering results with "unknown" field type in field value direct answer. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.directanswerprops.customcssclasses.md) | | [DirectAnswerCssClasses](./search-ui-react.directanswercssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [UnknownFieldTypeDisplay?](./search-ui-react.directanswerprops.unknownfieldtypedisplay.md) | | [UnknownFieldTypeDisplayComponent](./search-ui-react.unknownfieldtypedisplaycomponent.md) | _(Optional)_ A component to handle rendering results with "unknown" field type in field value direct answer. | diff --git a/docs/search-ui-react.directanswerprops.unknownfieldtypedisplay.md b/docs/search-ui-react.directanswerprops.unknownfieldtypedisplay.md index d69d7d7cf..48f504a38 100644 --- a/docs/search-ui-react.directanswerprops.unknownfieldtypedisplay.md +++ b/docs/search-ui-react.directanswerprops.unknownfieldtypedisplay.md @@ -6,7 +6,7 @@ A component to handle rendering results with "unknown" field type in field value direct answer. -Signature: +**Signature:** ```typescript UnknownFieldTypeDisplay?: UnknownFieldTypeDisplayComponent; diff --git a/docs/search-ui-react.dropdownitem.md b/docs/search-ui-react.dropdownitem.md index bba818843..6d056aa4c 100644 --- a/docs/search-ui-react.dropdownitem.md +++ b/docs/search-ui-react.dropdownitem.md @@ -6,7 +6,7 @@ A wrapper component for specifying a DropdownItemWithIndex. The index will be automatically provided by the Dropdown component instance. -Signature: +**Signature:** ```typescript declare function DropdownItem(_props: DropdownItemProps): JSX.Element | null; @@ -16,9 +16,9 @@ declare function DropdownItem(_props: DropdownItemProps): JSX.Element | null; | Parameter | Type | Description | | --- | --- | --- | -| \_props | DropdownItemProps | | +| \_props | [DropdownItemProps](./search-ui-react.dropdownitemprops.md) | | -Returns: +**Returns:** JSX.Element \| null diff --git a/docs/search-ui-react.dropdownitemprops.md b/docs/search-ui-react.dropdownitemprops.md index 1334e81a6..87f0c9f1a 100644 --- a/docs/search-ui-react.dropdownitemprops.md +++ b/docs/search-ui-react.dropdownitemprops.md @@ -6,7 +6,7 @@ Props for the [DropdownItem()](./search-ui-react.dropdownitem.md). -Signature: +**Signature:** ```typescript type DropdownItemProps = PropsWithChildren<{ @@ -18,3 +18,5 @@ type DropdownItemProps = PropsWithChildren<{ ariaLabel?: (value: string) => string; }>; ``` +**References:** [FocusedItemData](./search-ui-react.focuseditemdata.md) + diff --git a/docs/search-ui-react.executeautocomplete.md b/docs/search-ui-react.executeautocomplete.md index 60f0bbe7a..a8e849120 100644 --- a/docs/search-ui-react.executeautocomplete.md +++ b/docs/search-ui-react.executeautocomplete.md @@ -6,7 +6,7 @@ Executes a universal/vertical autocomplete search and return the corresponding response. -Signature: +**Signature:** ```typescript declare function executeAutocomplete(searchActions: SearchActions): Promise; @@ -18,7 +18,7 @@ declare function executeAutocomplete(searchActions: SearchActions): PromiseReturns: +**Returns:** Promise<AutocompleteResponse \| undefined> diff --git a/docs/search-ui-react.executesearch.md b/docs/search-ui-react.executesearch.md index 0e117b4cd..22f42d762 100644 --- a/docs/search-ui-react.executesearch.md +++ b/docs/search-ui-react.executesearch.md @@ -6,7 +6,7 @@ Executes a universal/vertical search. -Signature: +**Signature:** ```typescript declare function executeSearch(searchActions: SearchActions): Promise; @@ -18,7 +18,7 @@ declare function executeSearch(searchActions: SearchActions): Promise; | --- | --- | --- | | searchActions | SearchActions | | -Returns: +**Returns:** Promise<void> diff --git a/docs/search-ui-react.facetprops.md b/docs/search-ui-react.facetprops.md index 9dfeb1184..cbf703413 100644 --- a/docs/search-ui-react.facetprops.md +++ b/docs/search-ui-react.facetprops.md @@ -6,8 +6,10 @@ Props for a single facet component. -Signature: +**Signature:** ```typescript type FacetProps = StandardFacetProps | NumericalFacetProps | HierarchicalFacetProps; ``` +**References:** [StandardFacetProps](./search-ui-react.standardfacetprops.md), [NumericalFacetProps](./search-ui-react.numericalfacetprops.md), [HierarchicalFacetProps](./search-ui-react.hierarchicalfacetprops.md) + diff --git a/docs/search-ui-react.facets.md b/docs/search-ui-react.facets.md index 22dfe4735..c7046ab0a 100644 --- a/docs/search-ui-react.facets.md +++ b/docs/search-ui-react.facets.md @@ -6,21 +6,21 @@ A component that displays all facets applicable to the current vertical search. -Signature: +**Signature:** ```typescript -declare function Facets(props: FacetsProps): React.JSX.Element; +declare function Facets(props: FacetsProps): JSX.Element; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| props | FacetsProps | [FacetsProps](./search-ui-react.facetsprops.md) | +| props | [FacetsProps](./search-ui-react.facetsprops.md) | [FacetsProps](./search-ui-react.facetsprops.md) | -Returns: +**Returns:** -React.JSX.Element +JSX.Element A React component for facets diff --git a/docs/search-ui-react.facetscssclasses.divider.md b/docs/search-ui-react.facetscssclasses.divider.md index 7a478a5f7..b1a7132c0 100644 --- a/docs/search-ui-react.facetscssclasses.divider.md +++ b/docs/search-ui-react.facetscssclasses.divider.md @@ -4,7 +4,7 @@ ## FacetsCssClasses.divider property -Signature: +**Signature:** ```typescript divider?: string; diff --git a/docs/search-ui-react.facetscssclasses.facetscontainer.md b/docs/search-ui-react.facetscssclasses.facetscontainer.md index 1e90d3795..1163a91b5 100644 --- a/docs/search-ui-react.facetscssclasses.facetscontainer.md +++ b/docs/search-ui-react.facetscssclasses.facetscontainer.md @@ -4,7 +4,7 @@ ## FacetsCssClasses.facetsContainer property -Signature: +**Signature:** ```typescript facetsContainer?: string; diff --git a/docs/search-ui-react.facetscssclasses.md b/docs/search-ui-react.facetscssclasses.md index bba53832e..e2154e41e 100644 --- a/docs/search-ui-react.facetscssclasses.md +++ b/docs/search-ui-react.facetscssclasses.md @@ -6,17 +6,17 @@ The CSS class interface for [Facets()](./search-ui-react.facets.md). Any [FilterGroupCssClasses](./search-ui-react.filtergroupcssclasses.md) props will be overridden by the same props from customCssClasses on [StandardFacetProps](./search-ui-react.standardfacetprops.md), [NumericalFacetProps](./search-ui-react.numericalfacetprops.md), or [HierarchicalFacetProps](./search-ui-react.hierarchicalfacetprops.md). -Signature: +**Signature:** ```typescript interface FacetsCssClasses extends FilterGroupCssClasses ``` -Extends: FilterGroupCssClasses +**Extends:** [FilterGroupCssClasses](./search-ui-react.filtergroupcssclasses.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [divider?](./search-ui-react.facetscssclasses.divider.md) | string | (Optional) | -| [facetsContainer?](./search-ui-react.facetscssclasses.facetscontainer.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [divider?](./search-ui-react.facetscssclasses.divider.md) | | string | _(Optional)_ | +| [facetsContainer?](./search-ui-react.facetscssclasses.facetscontainer.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.facetsprops.children.md b/docs/search-ui-react.facetsprops.children.md index 1f661f275..ac3165650 100644 --- a/docs/search-ui-react.facetsprops.children.md +++ b/docs/search-ui-react.facetsprops.children.md @@ -6,7 +6,7 @@ The custom facet components that will override the default rendering. -Signature: +**Signature:** ```typescript children?: ReactElement[] | ReactElement | undefined | null; diff --git a/docs/search-ui-react.facetsprops.customcssclasses.md b/docs/search-ui-react.facetsprops.customcssclasses.md index 67d9622f6..81e525a8f 100644 --- a/docs/search-ui-react.facetsprops.customcssclasses.md +++ b/docs/search-ui-react.facetsprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: FacetsCssClasses; diff --git a/docs/search-ui-react.facetsprops.excludedfieldids.md b/docs/search-ui-react.facetsprops.excludedfieldids.md index 35c5f2335..e615e51df 100644 --- a/docs/search-ui-react.facetsprops.excludedfieldids.md +++ b/docs/search-ui-react.facetsprops.excludedfieldids.md @@ -6,7 +6,7 @@ List of field ids that should not be displayed. -Signature: +**Signature:** ```typescript excludedFieldIds?: string[]; diff --git a/docs/search-ui-react.facetsprops.hierarchicalfieldids.md b/docs/search-ui-react.facetsprops.hierarchicalfieldids.md index 615e21cf1..a56b1836c 100644 --- a/docs/search-ui-react.facetsprops.hierarchicalfieldids.md +++ b/docs/search-ui-react.facetsprops.hierarchicalfieldids.md @@ -6,7 +6,7 @@ List of field ids that should be rendered as hierarchical facets. -Signature: +**Signature:** ```typescript hierarchicalFieldIds?: string[]; diff --git a/docs/search-ui-react.facetsprops.md b/docs/search-ui-react.facetsprops.md index 8d2f9dd9f..a7acc13f8 100644 --- a/docs/search-ui-react.facetsprops.md +++ b/docs/search-ui-react.facetsprops.md @@ -6,7 +6,7 @@ Props for the [Facets()](./search-ui-react.facets.md) component. -Signature: +**Signature:** ```typescript interface FacetsProps @@ -14,12 +14,12 @@ interface FacetsProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [children?](./search-ui-react.facetsprops.children.md) | ReactElement\[\] \| ReactElement \| undefined \| null | (Optional) The custom facet components that will override the default rendering. | -| [customCssClasses?](./search-ui-react.facetsprops.customcssclasses.md) | FacetsCssClasses | (Optional) CSS classes for customizing the component styling. | -| [excludedFieldIds?](./search-ui-react.facetsprops.excludedfieldids.md) | string\[\] | (Optional) List of field ids that should not be displayed. | -| [hierarchicalFieldIds?](./search-ui-react.facetsprops.hierarchicalfieldids.md) | string\[\] | (Optional) List of field ids that should be rendered as hierarchical facets. | -| [onlyRenderChildren?](./search-ui-react.facetsprops.onlyrenderchildren.md) | boolean | (Optional) If set to true, only the facets specified in the children are rendered. If set to false, all facets are rendered with the ones specified in the children overridden. Default to false. | -| [searchOnChange?](./search-ui-react.facetsprops.searchonchange.md) | boolean | (Optional) Whether or not a search is automatically run when a filter is selected. Defaults to true. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [children?](./search-ui-react.facetsprops.children.md) | | ReactElement\[\] \| ReactElement \| undefined \| null | _(Optional)_ The custom facet components that will override the default rendering. | +| [customCssClasses?](./search-ui-react.facetsprops.customcssclasses.md) | | [FacetsCssClasses](./search-ui-react.facetscssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [excludedFieldIds?](./search-ui-react.facetsprops.excludedfieldids.md) | | string\[\] | _(Optional)_ List of field ids that should not be displayed. | +| [hierarchicalFieldIds?](./search-ui-react.facetsprops.hierarchicalfieldids.md) | | string\[\] | _(Optional)_ List of field ids that should be rendered as hierarchical facets. | +| [onlyRenderChildren?](./search-ui-react.facetsprops.onlyrenderchildren.md) | | boolean | _(Optional)_ If set to true, only the facets specified in the children are rendered. If set to false, all facets are rendered with the ones specified in the children overridden. Default to false. | +| [searchOnChange?](./search-ui-react.facetsprops.searchonchange.md) | | boolean | _(Optional)_ Whether or not a search is automatically run when a filter is selected. Defaults to true. | diff --git a/docs/search-ui-react.facetsprops.onlyrenderchildren.md b/docs/search-ui-react.facetsprops.onlyrenderchildren.md index f836cdc32..3a4ed8c67 100644 --- a/docs/search-ui-react.facetsprops.onlyrenderchildren.md +++ b/docs/search-ui-react.facetsprops.onlyrenderchildren.md @@ -6,7 +6,7 @@ If set to true, only the facets specified in the children are rendered. If set to false, all facets are rendered with the ones specified in the children overridden. Default to false. -Signature: +**Signature:** ```typescript onlyRenderChildren?: boolean; diff --git a/docs/search-ui-react.facetsprops.searchonchange.md b/docs/search-ui-react.facetsprops.searchonchange.md index 90c0cb05e..c38e8919e 100644 --- a/docs/search-ui-react.facetsprops.searchonchange.md +++ b/docs/search-ui-react.facetsprops.searchonchange.md @@ -6,7 +6,7 @@ Whether or not a search is automatically run when a filter is selected. Defaults to true. -Signature: +**Signature:** ```typescript searchOnChange?: boolean; diff --git a/docs/search-ui-react.feedbacktype.md b/docs/search-ui-react.feedbacktype.md index debc65018..d2da6546e 100644 --- a/docs/search-ui-react.feedbacktype.md +++ b/docs/search-ui-react.feedbacktype.md @@ -6,7 +6,7 @@ Analytics event types for quality feedback. -Signature: +**Signature:** ```typescript type FeedbackType = 'THUMBS_UP' | 'THUMBS_DOWN'; diff --git a/docs/search-ui-react.filterdivider.md b/docs/search-ui-react.filterdivider.md index 89a097178..a394a4789 100644 --- a/docs/search-ui-react.filterdivider.md +++ b/docs/search-ui-react.filterdivider.md @@ -6,7 +6,7 @@ A divider component used to separate NumericalFacets, HierarchicalFacets, StandardFacets, and StaticFilters. -Signature: +**Signature:** ```typescript declare function FilterDivider({ className }: { @@ -20,7 +20,7 @@ declare function FilterDivider({ className }: { | --- | --- | --- | | { className } | { className?: string; } | | -Returns: +**Returns:** JSX.Element diff --git a/docs/search-ui-react.filtergroupcssclasses.md b/docs/search-ui-react.filtergroupcssclasses.md index 154bf5c38..e5e925862 100644 --- a/docs/search-ui-react.filtergroupcssclasses.md +++ b/docs/search-ui-react.filtergroupcssclasses.md @@ -6,7 +6,7 @@ The CSS class interface for FilterGroup. -Signature: +**Signature:** ```typescript interface FilterGroupCssClasses @@ -14,12 +14,12 @@ interface FilterGroupCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [option?](./search-ui-react.filtergroupcssclasses.option.md) | string | (Optional) | -| [optionInput?](./search-ui-react.filtergroupcssclasses.optioninput.md) | string | (Optional) | -| [optionLabel?](./search-ui-react.filtergroupcssclasses.optionlabel.md) | string | (Optional) | -| [optionsContainer?](./search-ui-react.filtergroupcssclasses.optionscontainer.md) | string | (Optional) | -| [searchInput?](./search-ui-react.filtergroupcssclasses.searchinput.md) | string | (Optional) | -| [titleLabel?](./search-ui-react.filtergroupcssclasses.titlelabel.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [option?](./search-ui-react.filtergroupcssclasses.option.md) | | string | _(Optional)_ | +| [optionInput?](./search-ui-react.filtergroupcssclasses.optioninput.md) | | string | _(Optional)_ | +| [optionLabel?](./search-ui-react.filtergroupcssclasses.optionlabel.md) | | string | _(Optional)_ | +| [optionsContainer?](./search-ui-react.filtergroupcssclasses.optionscontainer.md) | | string | _(Optional)_ | +| [searchInput?](./search-ui-react.filtergroupcssclasses.searchinput.md) | | string | _(Optional)_ | +| [titleLabel?](./search-ui-react.filtergroupcssclasses.titlelabel.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.filtergroupcssclasses.option.md b/docs/search-ui-react.filtergroupcssclasses.option.md index f9a2d851f..e65ac2859 100644 --- a/docs/search-ui-react.filtergroupcssclasses.option.md +++ b/docs/search-ui-react.filtergroupcssclasses.option.md @@ -4,7 +4,7 @@ ## FilterGroupCssClasses.option property -Signature: +**Signature:** ```typescript option?: string; diff --git a/docs/search-ui-react.filtergroupcssclasses.optioninput.md b/docs/search-ui-react.filtergroupcssclasses.optioninput.md index 21f1c2503..e618a36f8 100644 --- a/docs/search-ui-react.filtergroupcssclasses.optioninput.md +++ b/docs/search-ui-react.filtergroupcssclasses.optioninput.md @@ -4,7 +4,7 @@ ## FilterGroupCssClasses.optionInput property -Signature: +**Signature:** ```typescript optionInput?: string; diff --git a/docs/search-ui-react.filtergroupcssclasses.optionlabel.md b/docs/search-ui-react.filtergroupcssclasses.optionlabel.md index e92fdd46d..71c1fa726 100644 --- a/docs/search-ui-react.filtergroupcssclasses.optionlabel.md +++ b/docs/search-ui-react.filtergroupcssclasses.optionlabel.md @@ -4,7 +4,7 @@ ## FilterGroupCssClasses.optionLabel property -Signature: +**Signature:** ```typescript optionLabel?: string; diff --git a/docs/search-ui-react.filtergroupcssclasses.optionscontainer.md b/docs/search-ui-react.filtergroupcssclasses.optionscontainer.md index 302088a70..f541afc6d 100644 --- a/docs/search-ui-react.filtergroupcssclasses.optionscontainer.md +++ b/docs/search-ui-react.filtergroupcssclasses.optionscontainer.md @@ -4,7 +4,7 @@ ## FilterGroupCssClasses.optionsContainer property -Signature: +**Signature:** ```typescript optionsContainer?: string; diff --git a/docs/search-ui-react.filtergroupcssclasses.searchinput.md b/docs/search-ui-react.filtergroupcssclasses.searchinput.md index 91257efa6..bef095d14 100644 --- a/docs/search-ui-react.filtergroupcssclasses.searchinput.md +++ b/docs/search-ui-react.filtergroupcssclasses.searchinput.md @@ -4,7 +4,7 @@ ## FilterGroupCssClasses.searchInput property -Signature: +**Signature:** ```typescript searchInput?: string; diff --git a/docs/search-ui-react.filtergroupcssclasses.titlelabel.md b/docs/search-ui-react.filtergroupcssclasses.titlelabel.md index 1339b7ef2..b5438533a 100644 --- a/docs/search-ui-react.filtergroupcssclasses.titlelabel.md +++ b/docs/search-ui-react.filtergroupcssclasses.titlelabel.md @@ -4,7 +4,7 @@ ## FilterGroupCssClasses.titleLabel property -Signature: +**Signature:** ```typescript titleLabel?: string; diff --git a/docs/search-ui-react.filtergroupprops.collapsible.md b/docs/search-ui-react.filtergroupprops.collapsible.md index 3ec153b78..494d1edcc 100644 --- a/docs/search-ui-react.filtergroupprops.collapsible.md +++ b/docs/search-ui-react.filtergroupprops.collapsible.md @@ -6,7 +6,7 @@ Whether or not the filter is collapsible. Defaults to true. -Signature: +**Signature:** ```typescript collapsible?: boolean; diff --git a/docs/search-ui-react.filtergroupprops.customcssclasses.md b/docs/search-ui-react.filtergroupprops.customcssclasses.md index d47e9e427..54dbefd7e 100644 --- a/docs/search-ui-react.filtergroupprops.customcssclasses.md +++ b/docs/search-ui-react.filtergroupprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: FilterGroupCssClasses; diff --git a/docs/search-ui-react.filtergroupprops.defaultexpanded.md b/docs/search-ui-react.filtergroupprops.defaultexpanded.md index 2924f422a..64de3652e 100644 --- a/docs/search-ui-react.filtergroupprops.defaultexpanded.md +++ b/docs/search-ui-react.filtergroupprops.defaultexpanded.md @@ -6,7 +6,7 @@ If the filter group is collapsible, whether or not it should start out expanded. Defaults to true. -Signature: +**Signature:** ```typescript defaultExpanded?: boolean; diff --git a/docs/search-ui-react.filtergroupprops.fieldid.md b/docs/search-ui-react.filtergroupprops.fieldid.md index bc13a70ed..92d495f90 100644 --- a/docs/search-ui-react.filtergroupprops.fieldid.md +++ b/docs/search-ui-react.filtergroupprops.fieldid.md @@ -6,7 +6,7 @@ The fieldId corresponding to the filter group. -Signature: +**Signature:** ```typescript fieldId: string; diff --git a/docs/search-ui-react.filtergroupprops.filteroptions.md b/docs/search-ui-react.filtergroupprops.filteroptions.md index 5e8aaee69..f03d4cb9e 100644 --- a/docs/search-ui-react.filtergroupprops.filteroptions.md +++ b/docs/search-ui-react.filtergroupprops.filteroptions.md @@ -6,7 +6,7 @@ The configuration data for a field value filter option. -Signature: +**Signature:** ```typescript filterOptions: FilterOptionConfig[]; diff --git a/docs/search-ui-react.filtergroupprops.md b/docs/search-ui-react.filtergroupprops.md index 9768748ac..b59b94814 100644 --- a/docs/search-ui-react.filtergroupprops.md +++ b/docs/search-ui-react.filtergroupprops.md @@ -6,7 +6,7 @@ Props for the FilterGroup component. -Signature: +**Signature:** ```typescript interface FilterGroupProps @@ -14,14 +14,14 @@ interface FilterGroupProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [collapsible?](./search-ui-react.filtergroupprops.collapsible.md) | boolean | (Optional) Whether or not the filter is collapsible. Defaults to true. | -| [customCssClasses?](./search-ui-react.filtergroupprops.customcssclasses.md) | FilterGroupCssClasses | (Optional) CSS classes for customizing the component styling. | -| [defaultExpanded?](./search-ui-react.filtergroupprops.defaultexpanded.md) | boolean | (Optional) If the filter group is collapsible, whether or not it should start out expanded. Defaults to true. | -| [fieldId](./search-ui-react.filtergroupprops.fieldid.md) | string | The fieldId corresponding to the filter group. | -| [filterOptions](./search-ui-react.filtergroupprops.filteroptions.md) | FilterOptionConfig\[\] | The configuration data for a field value filter option. | -| [searchable?](./search-ui-react.filtergroupprops.searchable.md) | boolean | (Optional) Whether or not to display a text input to search for filter options. | -| [showMoreLimit?](./search-ui-react.filtergroupprops.showmorelimit.md) | number | (Optional) Limit on the number of options to be displayed. | -| [title](./search-ui-react.filtergroupprops.title.md) | string | The displayed label for the filter group. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [collapsible?](./search-ui-react.filtergroupprops.collapsible.md) | | boolean | _(Optional)_ Whether or not the filter is collapsible. Defaults to true. | +| [customCssClasses?](./search-ui-react.filtergroupprops.customcssclasses.md) | | [FilterGroupCssClasses](./search-ui-react.filtergroupcssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [defaultExpanded?](./search-ui-react.filtergroupprops.defaultexpanded.md) | | boolean | _(Optional)_ If the filter group is collapsible, whether or not it should start out expanded. Defaults to true. | +| [fieldId](./search-ui-react.filtergroupprops.fieldid.md) | | string | The fieldId corresponding to the filter group. | +| [filterOptions](./search-ui-react.filtergroupprops.filteroptions.md) | | [FilterOptionConfig](./search-ui-react.filteroptionconfig.md)\[\] | The configuration data for a field value filter option. | +| [searchable?](./search-ui-react.filtergroupprops.searchable.md) | | boolean | _(Optional)_ Whether or not to display a text input to search for filter options. | +| [showMoreLimit?](./search-ui-react.filtergroupprops.showmorelimit.md) | | number | _(Optional)_ Limit on the number of options to be displayed. | +| [title](./search-ui-react.filtergroupprops.title.md) | | string | The displayed label for the filter group. | diff --git a/docs/search-ui-react.filtergroupprops.searchable.md b/docs/search-ui-react.filtergroupprops.searchable.md index 17adfee7f..e314d761e 100644 --- a/docs/search-ui-react.filtergroupprops.searchable.md +++ b/docs/search-ui-react.filtergroupprops.searchable.md @@ -6,7 +6,7 @@ Whether or not to display a text input to search for filter options. -Signature: +**Signature:** ```typescript searchable?: boolean; diff --git a/docs/search-ui-react.filtergroupprops.showmorelimit.md b/docs/search-ui-react.filtergroupprops.showmorelimit.md index f38fb7042..ccc2f7853 100644 --- a/docs/search-ui-react.filtergroupprops.showmorelimit.md +++ b/docs/search-ui-react.filtergroupprops.showmorelimit.md @@ -6,7 +6,7 @@ Limit on the number of options to be displayed. -Signature: +**Signature:** ```typescript showMoreLimit?: number; diff --git a/docs/search-ui-react.filtergroupprops.title.md b/docs/search-ui-react.filtergroupprops.title.md index e58291484..d7a9d14b8 100644 --- a/docs/search-ui-react.filtergroupprops.title.md +++ b/docs/search-ui-react.filtergroupprops.title.md @@ -6,7 +6,7 @@ The displayed label for the filter group. -Signature: +**Signature:** ```typescript title: string; diff --git a/docs/search-ui-react.filteroptionconfig.displayname.md b/docs/search-ui-react.filteroptionconfig.displayname.md index 11037c4a2..02a71694f 100644 --- a/docs/search-ui-react.filteroptionconfig.displayname.md +++ b/docs/search-ui-react.filteroptionconfig.displayname.md @@ -6,7 +6,7 @@ The display name. Defaults to the value prop. -Signature: +**Signature:** ```typescript displayName?: string; diff --git a/docs/search-ui-react.filteroptionconfig.matcher.md b/docs/search-ui-react.filteroptionconfig.matcher.md index bcb6d33d6..83712db66 100644 --- a/docs/search-ui-react.filteroptionconfig.matcher.md +++ b/docs/search-ui-react.filteroptionconfig.matcher.md @@ -6,7 +6,7 @@ The type of filtering operation used. Defaults to an equals comparison. -Signature: +**Signature:** ```typescript matcher?: Matcher; diff --git a/docs/search-ui-react.filteroptionconfig.md b/docs/search-ui-react.filteroptionconfig.md index f2a8b5c30..0b2e2c32a 100644 --- a/docs/search-ui-react.filteroptionconfig.md +++ b/docs/search-ui-react.filteroptionconfig.md @@ -6,7 +6,7 @@ The configuration data for a field value filter option. -Signature: +**Signature:** ```typescript interface FilterOptionConfig @@ -14,11 +14,11 @@ interface FilterOptionConfig ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [displayName?](./search-ui-react.filteroptionconfig.displayname.md) | string | (Optional) The display name. Defaults to the value prop. | -| [matcher?](./search-ui-react.filteroptionconfig.matcher.md) | Matcher | (Optional) The type of filtering operation used. Defaults to an equals comparison. | -| [resultsCount?](./search-ui-react.filteroptionconfig.resultscount.md) | number | (Optional) The number of results associated with this filter. | -| [selectedByDefault?](./search-ui-react.filteroptionconfig.selectedbydefault.md) | boolean | (Optional) If this particular filter should be selected by default. | -| [value](./search-ui-react.filteroptionconfig.value.md) | string \| number \| boolean \| NumberRangeValue | The value used to perform filtering. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [displayName?](./search-ui-react.filteroptionconfig.displayname.md) | | string | _(Optional)_ The display name. Defaults to the value prop. | +| [matcher?](./search-ui-react.filteroptionconfig.matcher.md) | | Matcher | _(Optional)_ The type of filtering operation used. Defaults to an equals comparison. | +| [resultsCount?](./search-ui-react.filteroptionconfig.resultscount.md) | | number | _(Optional)_ The number of results associated with this filter. | +| [selectedByDefault?](./search-ui-react.filteroptionconfig.selectedbydefault.md) | | boolean | _(Optional)_ If this particular filter should be selected by default. | +| [value](./search-ui-react.filteroptionconfig.value.md) | | string \| number \| boolean \| NumberRangeValue | The value used to perform filtering. | diff --git a/docs/search-ui-react.filteroptionconfig.resultscount.md b/docs/search-ui-react.filteroptionconfig.resultscount.md index d89e285be..dd2d53022 100644 --- a/docs/search-ui-react.filteroptionconfig.resultscount.md +++ b/docs/search-ui-react.filteroptionconfig.resultscount.md @@ -6,7 +6,7 @@ The number of results associated with this filter. -Signature: +**Signature:** ```typescript resultsCount?: number; diff --git a/docs/search-ui-react.filteroptionconfig.selectedbydefault.md b/docs/search-ui-react.filteroptionconfig.selectedbydefault.md index 30e1e2598..bed5672d9 100644 --- a/docs/search-ui-react.filteroptionconfig.selectedbydefault.md +++ b/docs/search-ui-react.filteroptionconfig.selectedbydefault.md @@ -6,7 +6,7 @@ If this particular filter should be selected by default. -Signature: +**Signature:** ```typescript selectedByDefault?: boolean; diff --git a/docs/search-ui-react.filteroptionconfig.value.md b/docs/search-ui-react.filteroptionconfig.value.md index 25a80ebfd..7df91fa89 100644 --- a/docs/search-ui-react.filteroptionconfig.value.md +++ b/docs/search-ui-react.filteroptionconfig.value.md @@ -6,7 +6,7 @@ The value used to perform filtering. -Signature: +**Signature:** ```typescript value: string | number | boolean | NumberRangeValue; diff --git a/docs/search-ui-react.filtersearch.md b/docs/search-ui-react.filtersearch.md index c9d20f3a9..2afb7a96d 100644 --- a/docs/search-ui-react.filtersearch.md +++ b/docs/search-ui-react.filtersearch.md @@ -6,7 +6,7 @@ A component which allows a user to search for filters associated with specific entities and fields. -Signature: +**Signature:** ```typescript declare function FilterSearch({ searchFields, label, placeholder, searchOnSelect, onSelect, sectioned, customCssClasses }: FilterSearchProps): JSX.Element; @@ -16,9 +16,9 @@ declare function FilterSearch({ searchFields, label, placeholder, searchOnSelect | Parameter | Type | Description | | --- | --- | --- | -| { searchFields, label, placeholder, searchOnSelect, onSelect, sectioned, customCssClasses } | FilterSearchProps | | +| { searchFields, label, placeholder, searchOnSelect, onSelect, sectioned, customCssClasses } | [FilterSearchProps](./search-ui-react.filtersearchprops.md) | | -Returns: +**Returns:** JSX.Element diff --git a/docs/search-ui-react.filtersearchcssclasses.filtersearchcontainer.md b/docs/search-ui-react.filtersearchcssclasses.filtersearchcontainer.md index 32d32d6a4..eadb09515 100644 --- a/docs/search-ui-react.filtersearchcssclasses.filtersearchcontainer.md +++ b/docs/search-ui-react.filtersearchcssclasses.filtersearchcontainer.md @@ -4,7 +4,7 @@ ## FilterSearchCssClasses.filterSearchContainer property -Signature: +**Signature:** ```typescript filterSearchContainer?: string; diff --git a/docs/search-ui-react.filtersearchcssclasses.focusedoption.md b/docs/search-ui-react.filtersearchcssclasses.focusedoption.md index bb7865967..5313f2e94 100644 --- a/docs/search-ui-react.filtersearchcssclasses.focusedoption.md +++ b/docs/search-ui-react.filtersearchcssclasses.focusedoption.md @@ -4,7 +4,7 @@ ## FilterSearchCssClasses.focusedOption property -Signature: +**Signature:** ```typescript focusedOption?: string; diff --git a/docs/search-ui-react.filtersearchcssclasses.inputelement.md b/docs/search-ui-react.filtersearchcssclasses.inputelement.md index abec6f90a..2e390adc0 100644 --- a/docs/search-ui-react.filtersearchcssclasses.inputelement.md +++ b/docs/search-ui-react.filtersearchcssclasses.inputelement.md @@ -4,7 +4,7 @@ ## FilterSearchCssClasses.inputElement property -Signature: +**Signature:** ```typescript inputElement?: string; diff --git a/docs/search-ui-react.filtersearchcssclasses.label.md b/docs/search-ui-react.filtersearchcssclasses.label.md index 6c2f9f43b..a23ab8ecb 100644 --- a/docs/search-ui-react.filtersearchcssclasses.label.md +++ b/docs/search-ui-react.filtersearchcssclasses.label.md @@ -4,7 +4,7 @@ ## FilterSearchCssClasses.label property -Signature: +**Signature:** ```typescript label?: string; diff --git a/docs/search-ui-react.filtersearchcssclasses.md b/docs/search-ui-react.filtersearchcssclasses.md index 5e9209b61..a335300d8 100644 --- a/docs/search-ui-react.filtersearchcssclasses.md +++ b/docs/search-ui-react.filtersearchcssclasses.md @@ -6,21 +6,21 @@ The CSS class interface for [FilterSearch()](./search-ui-react.filtersearch.md). -Signature: +**Signature:** ```typescript interface FilterSearchCssClasses extends AutocompleteResultCssClasses ``` -Extends: AutocompleteResultCssClasses +**Extends:** [AutocompleteResultCssClasses](./search-ui-react.autocompleteresultcssclasses.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [filterSearchContainer?](./search-ui-react.filtersearchcssclasses.filtersearchcontainer.md) | string | (Optional) | -| [focusedOption?](./search-ui-react.filtersearchcssclasses.focusedoption.md) | string | (Optional) | -| [inputElement?](./search-ui-react.filtersearchcssclasses.inputelement.md) | string | (Optional) | -| [label?](./search-ui-react.filtersearchcssclasses.label.md) | string | (Optional) | -| [optionsContainer?](./search-ui-react.filtersearchcssclasses.optionscontainer.md) | string | (Optional) | -| [sectionLabel?](./search-ui-react.filtersearchcssclasses.sectionlabel.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [filterSearchContainer?](./search-ui-react.filtersearchcssclasses.filtersearchcontainer.md) | | string | _(Optional)_ | +| [focusedOption?](./search-ui-react.filtersearchcssclasses.focusedoption.md) | | string | _(Optional)_ | +| [inputElement?](./search-ui-react.filtersearchcssclasses.inputelement.md) | | string | _(Optional)_ | +| [label?](./search-ui-react.filtersearchcssclasses.label.md) | | string | _(Optional)_ | +| [optionsContainer?](./search-ui-react.filtersearchcssclasses.optionscontainer.md) | | string | _(Optional)_ | +| [sectionLabel?](./search-ui-react.filtersearchcssclasses.sectionlabel.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.filtersearchcssclasses.optionscontainer.md b/docs/search-ui-react.filtersearchcssclasses.optionscontainer.md index ef8a42030..3604b4ea1 100644 --- a/docs/search-ui-react.filtersearchcssclasses.optionscontainer.md +++ b/docs/search-ui-react.filtersearchcssclasses.optionscontainer.md @@ -4,7 +4,7 @@ ## FilterSearchCssClasses.optionsContainer property -Signature: +**Signature:** ```typescript optionsContainer?: string; diff --git a/docs/search-ui-react.filtersearchcssclasses.sectionlabel.md b/docs/search-ui-react.filtersearchcssclasses.sectionlabel.md index 978061393..dc1e4da2a 100644 --- a/docs/search-ui-react.filtersearchcssclasses.sectionlabel.md +++ b/docs/search-ui-react.filtersearchcssclasses.sectionlabel.md @@ -4,7 +4,7 @@ ## FilterSearchCssClasses.sectionLabel property -Signature: +**Signature:** ```typescript sectionLabel?: string; diff --git a/docs/search-ui-react.filtersearchprops.customcssclasses.md b/docs/search-ui-react.filtersearchprops.customcssclasses.md index 6a81cc3c5..a9e7ac44a 100644 --- a/docs/search-ui-react.filtersearchprops.customcssclasses.md +++ b/docs/search-ui-react.filtersearchprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: FilterSearchCssClasses; diff --git a/docs/search-ui-react.filtersearchprops.label.md b/docs/search-ui-react.filtersearchprops.label.md index 0a498530c..6d4bf9430 100644 --- a/docs/search-ui-react.filtersearchprops.label.md +++ b/docs/search-ui-react.filtersearchprops.label.md @@ -6,7 +6,7 @@ The display label for the component. -Signature: +**Signature:** ```typescript label?: string; diff --git a/docs/search-ui-react.filtersearchprops.md b/docs/search-ui-react.filtersearchprops.md index 349f47c0a..8242d65e1 100644 --- a/docs/search-ui-react.filtersearchprops.md +++ b/docs/search-ui-react.filtersearchprops.md @@ -6,7 +6,7 @@ The props for the [FilterSearch()](./search-ui-react.filtersearch.md) component. -Signature: +**Signature:** ```typescript interface FilterSearchProps @@ -14,13 +14,13 @@ interface FilterSearchProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.filtersearchprops.customcssclasses.md) | FilterSearchCssClasses | (Optional) CSS classes for customizing the component styling. | -| [label?](./search-ui-react.filtersearchprops.label.md) | string | (Optional) The display label for the component. | -| [onSelect?](./search-ui-react.filtersearchprops.onselect.md) | (params: OnSelectParams) => void | (Optional) A function which is called when a filter is selected. | -| [placeholder?](./search-ui-react.filtersearchprops.placeholder.md) | string | (Optional) The search input's placeholder text when no text has been entered by the user. Defaults to "Search here...". | -| [searchFields](./search-ui-react.filtersearchprops.searchfields.md) | Omit<SearchParameterField, 'fetchEntities'>\[\] | An array of fieldApiName and entityType which indicates what to perform the filter search against. | -| [searchOnSelect?](./search-ui-react.filtersearchprops.searchonselect.md) | boolean | (Optional) Whether to trigger a search when an option is selected. Defaults to false. | -| [sectioned?](./search-ui-react.filtersearchprops.sectioned.md) | boolean | (Optional) Determines whether or not the results of the filter search are separated by field. Defaults to false. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.filtersearchprops.customcssclasses.md) | | [FilterSearchCssClasses](./search-ui-react.filtersearchcssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [label?](./search-ui-react.filtersearchprops.label.md) | | string | _(Optional)_ The display label for the component. | +| [onSelect?](./search-ui-react.filtersearchprops.onselect.md) | | (params: [OnSelectParams](./search-ui-react.onselectparams.md)) => void | _(Optional)_ A function which is called when a filter is selected. | +| [placeholder?](./search-ui-react.filtersearchprops.placeholder.md) | | string | _(Optional)_ The search input's placeholder text when no text has been entered by the user. Defaults to "Search here...". | +| [searchFields](./search-ui-react.filtersearchprops.searchfields.md) | | Omit<SearchParameterField, 'fetchEntities'>\[\] | An array of fieldApiName and entityType which indicates what to perform the filter search against. | +| [searchOnSelect?](./search-ui-react.filtersearchprops.searchonselect.md) | | boolean | _(Optional)_ Whether to trigger a search when an option is selected. Defaults to false. | +| [sectioned?](./search-ui-react.filtersearchprops.sectioned.md) | | boolean | _(Optional)_ Determines whether or not the results of the filter search are separated by field. Defaults to false. | diff --git a/docs/search-ui-react.filtersearchprops.onselect.md b/docs/search-ui-react.filtersearchprops.onselect.md index 9a6ce464c..e4f8cf8b3 100644 --- a/docs/search-ui-react.filtersearchprops.onselect.md +++ b/docs/search-ui-react.filtersearchprops.onselect.md @@ -6,7 +6,7 @@ A function which is called when a filter is selected. -Signature: +**Signature:** ```typescript onSelect?: (params: OnSelectParams) => void; diff --git a/docs/search-ui-react.filtersearchprops.placeholder.md b/docs/search-ui-react.filtersearchprops.placeholder.md index 619e690b5..a636b4e90 100644 --- a/docs/search-ui-react.filtersearchprops.placeholder.md +++ b/docs/search-ui-react.filtersearchprops.placeholder.md @@ -6,7 +6,7 @@ The search input's placeholder text when no text has been entered by the user. Defaults to "Search here...". -Signature: +**Signature:** ```typescript placeholder?: string; diff --git a/docs/search-ui-react.filtersearchprops.searchfields.md b/docs/search-ui-react.filtersearchprops.searchfields.md index 73fc11f4f..f84c54d99 100644 --- a/docs/search-ui-react.filtersearchprops.searchfields.md +++ b/docs/search-ui-react.filtersearchprops.searchfields.md @@ -6,7 +6,7 @@ An array of fieldApiName and entityType which indicates what to perform the filter search against. -Signature: +**Signature:** ```typescript searchFields: Omit[]; diff --git a/docs/search-ui-react.filtersearchprops.searchonselect.md b/docs/search-ui-react.filtersearchprops.searchonselect.md index 39ec94a54..3dfcdbda2 100644 --- a/docs/search-ui-react.filtersearchprops.searchonselect.md +++ b/docs/search-ui-react.filtersearchprops.searchonselect.md @@ -11,7 +11,7 @@ Whether to trigger a search when an option is selected. Defaults to false. -Signature: +**Signature:** ```typescript searchOnSelect?: boolean; diff --git a/docs/search-ui-react.filtersearchprops.sectioned.md b/docs/search-ui-react.filtersearchprops.sectioned.md index c0345ae7b..4e3894992 100644 --- a/docs/search-ui-react.filtersearchprops.sectioned.md +++ b/docs/search-ui-react.filtersearchprops.sectioned.md @@ -6,7 +6,7 @@ Determines whether or not the results of the filter search are separated by field. Defaults to false. -Signature: +**Signature:** ```typescript sectioned?: boolean; diff --git a/docs/search-ui-react.focuseditemdata.md b/docs/search-ui-react.focuseditemdata.md index 4fb7d8c5f..588466187 100644 --- a/docs/search-ui-react.focuseditemdata.md +++ b/docs/search-ui-react.focuseditemdata.md @@ -6,7 +6,7 @@ The data associated with the currently focused item. -Signature: +**Signature:** ```typescript type FocusedItemData = Record; diff --git a/docs/search-ui-react.geolocation_2.md b/docs/search-ui-react.geolocation_2.md index e2bf4a63c..91501f70b 100644 --- a/docs/search-ui-react.geolocation_2.md +++ b/docs/search-ui-react.geolocation_2.md @@ -6,7 +6,7 @@ A React Component which collects location information to create a location filter and perform a new search. -Signature: +**Signature:** ```typescript declare function Geolocation({ geolocationOptions, radius, label, GeolocationIcon, handleClick, customCssClasses, }: GeolocationProps): JSX.Element | null; @@ -16,9 +16,9 @@ declare function Geolocation({ geolocationOptions, radius, label, GeolocationIco | Parameter | Type | Description | | --- | --- | --- | -| { geolocationOptions, radius, label, GeolocationIcon, handleClick, customCssClasses, } | GeolocationProps | | +| { geolocationOptions, radius, label, GeolocationIcon, handleClick, customCssClasses, } | [GeolocationProps](./search-ui-react.geolocationprops.md) | | -Returns: +**Returns:** JSX.Element \| null diff --git a/docs/search-ui-react.geolocationcssclasses.button.md b/docs/search-ui-react.geolocationcssclasses.button.md index a140dab75..c39805fce 100644 --- a/docs/search-ui-react.geolocationcssclasses.button.md +++ b/docs/search-ui-react.geolocationcssclasses.button.md @@ -4,7 +4,7 @@ ## GeolocationCssClasses.button property -Signature: +**Signature:** ```typescript button?: string; diff --git a/docs/search-ui-react.geolocationcssclasses.geolocationcontainer.md b/docs/search-ui-react.geolocationcssclasses.geolocationcontainer.md index 377c506d5..9543468cd 100644 --- a/docs/search-ui-react.geolocationcssclasses.geolocationcontainer.md +++ b/docs/search-ui-react.geolocationcssclasses.geolocationcontainer.md @@ -4,7 +4,7 @@ ## GeolocationCssClasses.geolocationContainer property -Signature: +**Signature:** ```typescript geolocationContainer?: string; diff --git a/docs/search-ui-react.geolocationcssclasses.iconcontainer.md b/docs/search-ui-react.geolocationcssclasses.iconcontainer.md index 467401468..7fc6d35b7 100644 --- a/docs/search-ui-react.geolocationcssclasses.iconcontainer.md +++ b/docs/search-ui-react.geolocationcssclasses.iconcontainer.md @@ -4,7 +4,7 @@ ## GeolocationCssClasses.iconContainer property -Signature: +**Signature:** ```typescript iconContainer?: string; diff --git a/docs/search-ui-react.geolocationcssclasses.md b/docs/search-ui-react.geolocationcssclasses.md index 5998e01d0..64d5a090b 100644 --- a/docs/search-ui-react.geolocationcssclasses.md +++ b/docs/search-ui-react.geolocationcssclasses.md @@ -6,7 +6,7 @@ The CSS class interface for the Geolocation component. -Signature: +**Signature:** ```typescript interface GeolocationCssClasses @@ -14,9 +14,9 @@ interface GeolocationCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [button?](./search-ui-react.geolocationcssclasses.button.md) | string | (Optional) | -| [geolocationContainer?](./search-ui-react.geolocationcssclasses.geolocationcontainer.md) | string | (Optional) | -| [iconContainer?](./search-ui-react.geolocationcssclasses.iconcontainer.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [button?](./search-ui-react.geolocationcssclasses.button.md) | | string | _(Optional)_ | +| [geolocationContainer?](./search-ui-react.geolocationcssclasses.geolocationcontainer.md) | | string | _(Optional)_ | +| [iconContainer?](./search-ui-react.geolocationcssclasses.iconcontainer.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.geolocationprops.customcssclasses.md b/docs/search-ui-react.geolocationprops.customcssclasses.md index b4b7a71f1..bf1f564ed 100644 --- a/docs/search-ui-react.geolocationprops.customcssclasses.md +++ b/docs/search-ui-react.geolocationprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: GeolocationCssClasses; diff --git a/docs/search-ui-react.geolocationprops.geolocationicon.md b/docs/search-ui-react.geolocationprops.geolocationicon.md index afcf079c9..29ccc362a 100644 --- a/docs/search-ui-react.geolocationprops.geolocationicon.md +++ b/docs/search-ui-react.geolocationprops.geolocationicon.md @@ -6,7 +6,7 @@ Custom icon component to display along with the button. -Signature: +**Signature:** ```typescript GeolocationIcon?: React.FunctionComponent; diff --git a/docs/search-ui-react.geolocationprops.geolocationoptions.md b/docs/search-ui-react.geolocationprops.geolocationoptions.md index 2b3a2020f..53a8fdd04 100644 --- a/docs/search-ui-react.geolocationprops.geolocationoptions.md +++ b/docs/search-ui-react.geolocationprops.geolocationoptions.md @@ -6,7 +6,7 @@ Configuration used when collecting the user's location. Definition: [https://w3c.github.io/geolocation-api/\#position\_options\_interface](https://w3c.github.io/geolocation-api/#position_options_interface). -Signature: +**Signature:** ```typescript geolocationOptions?: PositionOptions; diff --git a/docs/search-ui-react.geolocationprops.handleclick.md b/docs/search-ui-react.geolocationprops.handleclick.md index 5e86891a8..0143c6601 100644 --- a/docs/search-ui-react.geolocationprops.handleclick.md +++ b/docs/search-ui-react.geolocationprops.handleclick.md @@ -6,7 +6,7 @@ A function which is called when the geolocation button is clicked, after user's position is successfully determined. -Signature: +**Signature:** ```typescript handleClick?: (position: GeolocationPosition) => void; diff --git a/docs/search-ui-react.geolocationprops.label.md b/docs/search-ui-react.geolocationprops.label.md index 128d01079..5c098a915 100644 --- a/docs/search-ui-react.geolocationprops.label.md +++ b/docs/search-ui-react.geolocationprops.label.md @@ -6,7 +6,7 @@ The label for the button. Defaults to 'Use my location'. -Signature: +**Signature:** ```typescript label?: string; diff --git a/docs/search-ui-react.geolocationprops.md b/docs/search-ui-react.geolocationprops.md index 1e10e0e29..3e81d948e 100644 --- a/docs/search-ui-react.geolocationprops.md +++ b/docs/search-ui-react.geolocationprops.md @@ -6,7 +6,7 @@ The props for the Geolocation component. -Signature: +**Signature:** ```typescript interface GeolocationProps @@ -14,12 +14,12 @@ interface GeolocationProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.geolocationprops.customcssclasses.md) | GeolocationCssClasses | (Optional) CSS classes for customizing the component styling. | -| [GeolocationIcon?](./search-ui-react.geolocationprops.geolocationicon.md) | React.FunctionComponent | (Optional) Custom icon component to display along with the button. | -| [geolocationOptions?](./search-ui-react.geolocationprops.geolocationoptions.md) | PositionOptions | (Optional) Configuration used when collecting the user's location. Definition: [https://w3c.github.io/geolocation-api/\#position\_options\_interface](https://w3c.github.io/geolocation-api/#position_options_interface). | -| [handleClick?](./search-ui-react.geolocationprops.handleclick.md) | (position: GeolocationPosition) => void | (Optional) A function which is called when the geolocation button is clicked, after user's position is successfully determined. | -| [label?](./search-ui-react.geolocationprops.label.md) | string | (Optional) The label for the button. Defaults to 'Use my location'. | -| [radius?](./search-ui-react.geolocationprops.radius.md) | number | (Optional) The radius, in miles, around the user's location to find results. Defaults to 50. If location accuracy is low, a larger radius may be used automatically. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.geolocationprops.customcssclasses.md) | | [GeolocationCssClasses](./search-ui-react.geolocationcssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [GeolocationIcon?](./search-ui-react.geolocationprops.geolocationicon.md) | | React.FunctionComponent | _(Optional)_ Custom icon component to display along with the button. | +| [geolocationOptions?](./search-ui-react.geolocationprops.geolocationoptions.md) | | PositionOptions | _(Optional)_ Configuration used when collecting the user's location. Definition: [https://w3c.github.io/geolocation-api/\#position\_options\_interface](https://w3c.github.io/geolocation-api/#position_options_interface). | +| [handleClick?](./search-ui-react.geolocationprops.handleclick.md) | | (position: GeolocationPosition) => void | _(Optional)_ A function which is called when the geolocation button is clicked, after user's position is successfully determined. | +| [label?](./search-ui-react.geolocationprops.label.md) | | string | _(Optional)_ The label for the button. Defaults to 'Use my location'. | +| [radius?](./search-ui-react.geolocationprops.radius.md) | | number | _(Optional)_ The radius, in miles, around the user's location to find results. Defaults to 50. If location accuracy is low, a larger radius may be used automatically. | diff --git a/docs/search-ui-react.geolocationprops.radius.md b/docs/search-ui-react.geolocationprops.radius.md index 62d171e06..da3a591af 100644 --- a/docs/search-ui-react.geolocationprops.radius.md +++ b/docs/search-ui-react.geolocationprops.radius.md @@ -6,7 +6,7 @@ The radius, in miles, around the user's location to find results. Defaults to 50. If location accuracy is low, a larger radius may be used automatically. -Signature: +**Signature:** ```typescript radius?: number; diff --git a/docs/search-ui-react.getsearchintents.md b/docs/search-ui-react.getsearchintents.md index 49531952b..480b2b23e 100644 --- a/docs/search-ui-react.getsearchintents.md +++ b/docs/search-ui-react.getsearchintents.md @@ -6,7 +6,7 @@ Get search intents of the current query stored in headless using autocomplete request. -Signature: +**Signature:** ```typescript declare function getSearchIntents(searchActions: SearchActions): Promise; @@ -18,7 +18,7 @@ declare function getSearchIntents(searchActions: SearchActions): PromiseReturns: +**Returns:** Promise<SearchIntent\[\] \| undefined> diff --git a/docs/search-ui-react.getuserlocation.md b/docs/search-ui-react.getuserlocation.md index d29060500..e31791f41 100644 --- a/docs/search-ui-react.getuserlocation.md +++ b/docs/search-ui-react.getuserlocation.md @@ -6,7 +6,7 @@ Retrieves user's location using navigator.geolocation API. -Signature: +**Signature:** ```typescript declare function getUserLocation(geolocationOptions?: PositionOptions): Promise; @@ -16,9 +16,9 @@ declare function getUserLocation(geolocationOptions?: PositionOptions): Promise< | Parameter | Type | Description | | --- | --- | --- | -| geolocationOptions | PositionOptions | | +| geolocationOptions | PositionOptions | _(Optional)_ | -Returns: +**Returns:** Promise<GeolocationPosition> diff --git a/docs/search-ui-react.hierarchicalfacet.md b/docs/search-ui-react.hierarchicalfacet.md index a250b6221..44e28372f 100644 --- a/docs/search-ui-react.hierarchicalfacet.md +++ b/docs/search-ui-react.hierarchicalfacet.md @@ -6,7 +6,7 @@ A component that displays a single hierarchical facet, in a tree level structure, applicable to the current vertical search. Use this to override the default rendering. -Signature: +**Signature:** ```typescript declare function HierarchicalFacet(props: HierarchicalFacetProps): null; @@ -16,9 +16,9 @@ declare function HierarchicalFacet(props: HierarchicalFacetProps): null; | Parameter | Type | Description | | --- | --- | --- | -| props | HierarchicalFacetProps | [HierarchicalFacetProps](./search-ui-react.hierarchicalfacetprops.md) | +| props | [HierarchicalFacetProps](./search-ui-react.hierarchicalfacetprops.md) | [HierarchicalFacetProps](./search-ui-react.hierarchicalfacetprops.md) | -Returns: +**Returns:** null diff --git a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.allcategoriesoption___active.md b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.allcategoriesoption___active.md index 2993c3376..24b5449a7 100644 --- a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.allcategoriesoption___active.md +++ b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.allcategoriesoption___active.md @@ -4,7 +4,7 @@ ## HierarchicalFacetDisplayCssClasses.allCategoriesOption\_\_\_active property -Signature: +**Signature:** ```typescript allCategoriesOption___active?: string; diff --git a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.allcategoriesoption___inactive.md b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.allcategoriesoption___inactive.md index 92d7d9603..8bffbfa9a 100644 --- a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.allcategoriesoption___inactive.md +++ b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.allcategoriesoption___inactive.md @@ -4,7 +4,7 @@ ## HierarchicalFacetDisplayCssClasses.allCategoriesOption\_\_\_inactive property -Signature: +**Signature:** ```typescript allCategoriesOption___inactive?: string; diff --git a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.availableoption__active.md b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.availableoption__active.md index 28a1b897f..ae69ba145 100644 --- a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.availableoption__active.md +++ b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.availableoption__active.md @@ -4,7 +4,7 @@ ## HierarchicalFacetDisplayCssClasses.availableOption\_\_active property -Signature: +**Signature:** ```typescript availableOption__active?: string; diff --git a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.availableoption__inactive.md b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.availableoption__inactive.md index b2ee41ac8..39c40d0c5 100644 --- a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.availableoption__inactive.md +++ b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.availableoption__inactive.md @@ -4,7 +4,7 @@ ## HierarchicalFacetDisplayCssClasses.availableOption\_\_inactive property -Signature: +**Signature:** ```typescript availableOption__inactive?: string; diff --git a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.currentcategory.md b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.currentcategory.md index 80ab9b7e1..0960d60e4 100644 --- a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.currentcategory.md +++ b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.currentcategory.md @@ -4,7 +4,7 @@ ## HierarchicalFacetDisplayCssClasses.currentCategory property -Signature: +**Signature:** ```typescript currentCategory?: string; diff --git a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.md b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.md index 788364bc9..68546abe8 100644 --- a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.md +++ b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.md @@ -6,7 +6,7 @@ The CSS class interface for HierarchicalFacetDisplay. -Signature: +**Signature:** ```typescript interface HierarchicalFacetDisplayCssClasses @@ -14,14 +14,14 @@ interface HierarchicalFacetDisplayCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [allCategoriesOption\_\_\_active?](./search-ui-react.hierarchicalfacetdisplaycssclasses.allcategoriesoption___active.md) | string | (Optional) | -| [allCategoriesOption\_\_\_inactive?](./search-ui-react.hierarchicalfacetdisplaycssclasses.allcategoriesoption___inactive.md) | string | (Optional) | -| [availableOption\_\_active?](./search-ui-react.hierarchicalfacetdisplaycssclasses.availableoption__active.md) | string | (Optional) | -| [availableOption\_\_inactive?](./search-ui-react.hierarchicalfacetdisplaycssclasses.availableoption__inactive.md) | string | (Optional) | -| [currentCategory?](./search-ui-react.hierarchicalfacetdisplaycssclasses.currentcategory.md) | string | (Optional) | -| [parentCategory?](./search-ui-react.hierarchicalfacetdisplaycssclasses.parentcategory.md) | string | (Optional) | -| [showMoreButton?](./search-ui-react.hierarchicalfacetdisplaycssclasses.showmorebutton.md) | string | (Optional) | -| [treeContainer?](./search-ui-react.hierarchicalfacetdisplaycssclasses.treecontainer.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [allCategoriesOption\_\_\_active?](./search-ui-react.hierarchicalfacetdisplaycssclasses.allcategoriesoption___active.md) | | string | _(Optional)_ | +| [allCategoriesOption\_\_\_inactive?](./search-ui-react.hierarchicalfacetdisplaycssclasses.allcategoriesoption___inactive.md) | | string | _(Optional)_ | +| [availableOption\_\_active?](./search-ui-react.hierarchicalfacetdisplaycssclasses.availableoption__active.md) | | string | _(Optional)_ | +| [availableOption\_\_inactive?](./search-ui-react.hierarchicalfacetdisplaycssclasses.availableoption__inactive.md) | | string | _(Optional)_ | +| [currentCategory?](./search-ui-react.hierarchicalfacetdisplaycssclasses.currentcategory.md) | | string | _(Optional)_ | +| [parentCategory?](./search-ui-react.hierarchicalfacetdisplaycssclasses.parentcategory.md) | | string | _(Optional)_ | +| [showMoreButton?](./search-ui-react.hierarchicalfacetdisplaycssclasses.showmorebutton.md) | | string | _(Optional)_ | +| [treeContainer?](./search-ui-react.hierarchicalfacetdisplaycssclasses.treecontainer.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.parentcategory.md b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.parentcategory.md index 92992ee7d..c777f111d 100644 --- a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.parentcategory.md +++ b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.parentcategory.md @@ -4,7 +4,7 @@ ## HierarchicalFacetDisplayCssClasses.parentCategory property -Signature: +**Signature:** ```typescript parentCategory?: string; diff --git a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.showmorebutton.md b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.showmorebutton.md index 7570c104d..b775fc0a8 100644 --- a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.showmorebutton.md +++ b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.showmorebutton.md @@ -4,7 +4,7 @@ ## HierarchicalFacetDisplayCssClasses.showMoreButton property -Signature: +**Signature:** ```typescript showMoreButton?: string; diff --git a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.treecontainer.md b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.treecontainer.md index ecacfa8f8..cff8a6376 100644 --- a/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.treecontainer.md +++ b/docs/search-ui-react.hierarchicalfacetdisplaycssclasses.treecontainer.md @@ -4,7 +4,7 @@ ## HierarchicalFacetDisplayCssClasses.treeContainer property -Signature: +**Signature:** ```typescript treeContainer?: string; diff --git a/docs/search-ui-react.hierarchicalfacetprops.customcssclasses.md b/docs/search-ui-react.hierarchicalfacetprops.customcssclasses.md index 95f63b014..815855733 100644 --- a/docs/search-ui-react.hierarchicalfacetprops.customcssclasses.md +++ b/docs/search-ui-react.hierarchicalfacetprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: HierarchicalFacetCustomCssClasses; diff --git a/docs/search-ui-react.hierarchicalfacetprops.delimiter.md b/docs/search-ui-react.hierarchicalfacetprops.delimiter.md index 571bc3323..fa3e30913 100644 --- a/docs/search-ui-react.hierarchicalfacetprops.delimiter.md +++ b/docs/search-ui-react.hierarchicalfacetprops.delimiter.md @@ -6,7 +6,7 @@ The delimiter for determining facet hierarchies, defaults to ">". -Signature: +**Signature:** ```typescript delimiter?: string; diff --git a/docs/search-ui-react.hierarchicalfacetprops.md b/docs/search-ui-react.hierarchicalfacetprops.md index d0ca01b97..276b7aad2 100644 --- a/docs/search-ui-react.hierarchicalfacetprops.md +++ b/docs/search-ui-react.hierarchicalfacetprops.md @@ -6,19 +6,19 @@ Props for the [StandardFacet()](./search-ui-react.standardfacet.md) component. -Signature: +**Signature:** ```typescript interface HierarchicalFacetProps extends Omit ``` -Extends: Omit<StandardFacetProps, 'transformOptions' \| 'showOptionCounts'> +**Extends:** Omit<[StandardFacetProps](./search-ui-react.standardfacetprops.md), 'transformOptions' \| 'showOptionCounts'> ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.hierarchicalfacetprops.customcssclasses.md) | HierarchicalFacetCustomCssClasses | (Optional) CSS classes for customizing the component styling. | -| [delimiter?](./search-ui-react.hierarchicalfacetprops.delimiter.md) | string | (Optional) The delimiter for determining facet hierarchies, defaults to ">". | -| [showMoreLimit?](./search-ui-react.hierarchicalfacetprops.showmorelimit.md) | number | (Optional) The maximum number of options to render before displaying the "Show more/less" button. Defaults to 4. | -| [transformOptions?](./search-ui-react.hierarchicalfacetprops.transformoptions.md) | (options: DisplayableFacetOption\[\]) => DisplayableFacetOption\[\] | (Optional) A function to transform facet's options. The returned options need to be delimited to keep the hierarchy. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.hierarchicalfacetprops.customcssclasses.md) | | HierarchicalFacetCustomCssClasses | _(Optional)_ CSS classes for customizing the component styling. | +| [delimiter?](./search-ui-react.hierarchicalfacetprops.delimiter.md) | | string | _(Optional)_ The delimiter for determining facet hierarchies, defaults to ">". | +| [showMoreLimit?](./search-ui-react.hierarchicalfacetprops.showmorelimit.md) | | number | _(Optional)_ The maximum number of options to render before displaying the "Show more/less" button. Defaults to 4. | +| [transformOptions?](./search-ui-react.hierarchicalfacetprops.transformoptions.md) | | (options: DisplayableFacetOption\[\]) => DisplayableFacetOption\[\] | _(Optional)_ A function to transform facet's options. The returned options need to be delimited to keep the hierarchy. | diff --git a/docs/search-ui-react.hierarchicalfacetprops.showmorelimit.md b/docs/search-ui-react.hierarchicalfacetprops.showmorelimit.md index 6469cb024..08e43bd52 100644 --- a/docs/search-ui-react.hierarchicalfacetprops.showmorelimit.md +++ b/docs/search-ui-react.hierarchicalfacetprops.showmorelimit.md @@ -6,7 +6,7 @@ The maximum number of options to render before displaying the "Show more/less" button. Defaults to 4. -Signature: +**Signature:** ```typescript showMoreLimit?: number; diff --git a/docs/search-ui-react.hierarchicalfacetprops.transformoptions.md b/docs/search-ui-react.hierarchicalfacetprops.transformoptions.md index 8a789b5c9..234be6efd 100644 --- a/docs/search-ui-react.hierarchicalfacetprops.transformoptions.md +++ b/docs/search-ui-react.hierarchicalfacetprops.transformoptions.md @@ -6,7 +6,7 @@ A function to transform facet's options. The returned options need to be delimited to keep the hierarchy. -Signature: +**Signature:** ```typescript transformOptions?: (options: DisplayableFacetOption[]) => DisplayableFacetOption[]; diff --git a/docs/search-ui-react.hierarchicalfacets.md b/docs/search-ui-react.hierarchicalfacets.md index bad65386d..e2a1727ea 100644 --- a/docs/search-ui-react.hierarchicalfacets.md +++ b/docs/search-ui-react.hierarchicalfacets.md @@ -11,21 +11,21 @@ A component that displays hierarchical facets, in a tree level structure, applicable to the current vertical search. -Signature: +**Signature:** ```typescript -declare function HierarchicalFacets({ searchOnChange, collapsible, defaultExpanded, includedFieldIds, customCssClasses, delimiter, showMoreLimit }: HierarchicalFacetsProps): React.JSX.Element; +declare function HierarchicalFacets({ searchOnChange, collapsible, defaultExpanded, includedFieldIds, customCssClasses, delimiter, showMoreLimit }: HierarchicalFacetsProps): JSX.Element; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| { searchOnChange, collapsible, defaultExpanded, includedFieldIds, customCssClasses, delimiter, showMoreLimit } | HierarchicalFacetsProps | | +| { searchOnChange, collapsible, defaultExpanded, includedFieldIds, customCssClasses, delimiter, showMoreLimit } | [HierarchicalFacetsProps](./search-ui-react.hierarchicalfacetsprops.md) | | -Returns: +**Returns:** -React.JSX.Element +JSX.Element A React component for facets diff --git a/docs/search-ui-react.hierarchicalfacetscssclasses.divider.md b/docs/search-ui-react.hierarchicalfacetscssclasses.divider.md index 0620e5751..1be9f1e88 100644 --- a/docs/search-ui-react.hierarchicalfacetscssclasses.divider.md +++ b/docs/search-ui-react.hierarchicalfacetscssclasses.divider.md @@ -4,7 +4,7 @@ ## HierarchicalFacetsCssClasses.divider property -Signature: +**Signature:** ```typescript divider?: string; diff --git a/docs/search-ui-react.hierarchicalfacetscssclasses.hierarchicalfacetscontainer.md b/docs/search-ui-react.hierarchicalfacetscssclasses.hierarchicalfacetscontainer.md index 9540df774..46a7940f5 100644 --- a/docs/search-ui-react.hierarchicalfacetscssclasses.hierarchicalfacetscontainer.md +++ b/docs/search-ui-react.hierarchicalfacetscssclasses.hierarchicalfacetscontainer.md @@ -4,7 +4,7 @@ ## HierarchicalFacetsCssClasses.hierarchicalFacetsContainer property -Signature: +**Signature:** ```typescript hierarchicalFacetsContainer?: string; diff --git a/docs/search-ui-react.hierarchicalfacetscssclasses.md b/docs/search-ui-react.hierarchicalfacetscssclasses.md index 5a4a1ec0d..78759aa95 100644 --- a/docs/search-ui-react.hierarchicalfacetscssclasses.md +++ b/docs/search-ui-react.hierarchicalfacetscssclasses.md @@ -6,17 +6,17 @@ The CSS class interface for [HierarchicalFacets()](./search-ui-react.hierarchicalfacets.md). -Signature: +**Signature:** ```typescript interface HierarchicalFacetsCssClasses extends HierarchicalFacetDisplayCssClasses ``` -Extends: HierarchicalFacetDisplayCssClasses +**Extends:** [HierarchicalFacetDisplayCssClasses](./search-ui-react.hierarchicalfacetdisplaycssclasses.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [divider?](./search-ui-react.hierarchicalfacetscssclasses.divider.md) | string | (Optional) | -| [hierarchicalFacetsContainer?](./search-ui-react.hierarchicalfacetscssclasses.hierarchicalfacetscontainer.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [divider?](./search-ui-react.hierarchicalfacetscssclasses.divider.md) | | string | _(Optional)_ | +| [hierarchicalFacetsContainer?](./search-ui-react.hierarchicalfacetscssclasses.hierarchicalfacetscontainer.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.hierarchicalfacetsprops.customcssclasses.md b/docs/search-ui-react.hierarchicalfacetsprops.customcssclasses.md index 1396c05d6..a8523eebd 100644 --- a/docs/search-ui-react.hierarchicalfacetsprops.customcssclasses.md +++ b/docs/search-ui-react.hierarchicalfacetsprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: HierarchicalFacetsCssClasses; diff --git a/docs/search-ui-react.hierarchicalfacetsprops.delimiter.md b/docs/search-ui-react.hierarchicalfacetsprops.delimiter.md index 3e4e64d5f..7a76d518b 100644 --- a/docs/search-ui-react.hierarchicalfacetsprops.delimiter.md +++ b/docs/search-ui-react.hierarchicalfacetsprops.delimiter.md @@ -6,7 +6,7 @@ The delimiter for determining facet hierarchies, defaults to ">". -Signature: +**Signature:** ```typescript delimiter?: string; diff --git a/docs/search-ui-react.hierarchicalfacetsprops.includedfieldids.md b/docs/search-ui-react.hierarchicalfacetsprops.includedfieldids.md index be5b8f54d..20e73f218 100644 --- a/docs/search-ui-react.hierarchicalfacetsprops.includedfieldids.md +++ b/docs/search-ui-react.hierarchicalfacetsprops.includedfieldids.md @@ -6,7 +6,7 @@ List of filter ids to render as hierarchical facets. -Signature: +**Signature:** ```typescript includedFieldIds: string[]; diff --git a/docs/search-ui-react.hierarchicalfacetsprops.md b/docs/search-ui-react.hierarchicalfacetsprops.md index 5f89bc7cc..905ef4256 100644 --- a/docs/search-ui-react.hierarchicalfacetsprops.md +++ b/docs/search-ui-react.hierarchicalfacetsprops.md @@ -11,19 +11,19 @@ Props for the [HierarchicalFacets()](./search-ui-react.hierarchicalfacets.md) component. -Signature: +**Signature:** ```typescript interface HierarchicalFacetsProps extends Omit ``` -Extends: Omit<StandardFacetsProps, 'excludedFieldIds'> +**Extends:** Omit<[StandardFacetsProps](./search-ui-react.standardfacetsprops.md), 'excludedFieldIds'> ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.hierarchicalfacetsprops.customcssclasses.md) | HierarchicalFacetsCssClasses | (Optional) CSS classes for customizing the component styling. | -| [delimiter?](./search-ui-react.hierarchicalfacetsprops.delimiter.md) | string | (Optional) The delimiter for determining facet hierarchies, defaults to ">". | -| [includedFieldIds](./search-ui-react.hierarchicalfacetsprops.includedfieldids.md) | string\[\] | List of filter ids to render as hierarchical facets. | -| [showMoreLimit?](./search-ui-react.hierarchicalfacetsprops.showmorelimit.md) | number | (Optional) The maximum number of options to render before displaying the "Show more/less" button. Defaults to 4. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.hierarchicalfacetsprops.customcssclasses.md) | | [HierarchicalFacetsCssClasses](./search-ui-react.hierarchicalfacetscssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [delimiter?](./search-ui-react.hierarchicalfacetsprops.delimiter.md) | | string | _(Optional)_ The delimiter for determining facet hierarchies, defaults to ">". | +| [includedFieldIds](./search-ui-react.hierarchicalfacetsprops.includedfieldids.md) | | string\[\] | List of filter ids to render as hierarchical facets. | +| [showMoreLimit?](./search-ui-react.hierarchicalfacetsprops.showmorelimit.md) | | number | _(Optional)_ The maximum number of options to render before displaying the "Show more/less" button. Defaults to 4. | diff --git a/docs/search-ui-react.hierarchicalfacetsprops.showmorelimit.md b/docs/search-ui-react.hierarchicalfacetsprops.showmorelimit.md index 73d789890..1010ea963 100644 --- a/docs/search-ui-react.hierarchicalfacetsprops.showmorelimit.md +++ b/docs/search-ui-react.hierarchicalfacetsprops.showmorelimit.md @@ -6,7 +6,7 @@ The maximum number of options to render before displaying the "Show more/less" button. Defaults to 4. -Signature: +**Signature:** ```typescript showMoreLimit?: number; diff --git a/docs/search-ui-react.highlightedvaluecssclasses.highlighted.md b/docs/search-ui-react.highlightedvaluecssclasses.highlighted.md index 83d5a567e..aa799224b 100644 --- a/docs/search-ui-react.highlightedvaluecssclasses.highlighted.md +++ b/docs/search-ui-react.highlightedvaluecssclasses.highlighted.md @@ -4,7 +4,7 @@ ## HighlightedValueCssClasses.highlighted property -Signature: +**Signature:** ```typescript highlighted?: string; diff --git a/docs/search-ui-react.highlightedvaluecssclasses.md b/docs/search-ui-react.highlightedvaluecssclasses.md index 100d09315..f18929da1 100644 --- a/docs/search-ui-react.highlightedvaluecssclasses.md +++ b/docs/search-ui-react.highlightedvaluecssclasses.md @@ -6,7 +6,7 @@ The CSS class interface for [renderHighlightedValue()](./search-ui-react.renderhighlightedvalue.md). -Signature: +**Signature:** ```typescript interface HighlightedValueCssClasses @@ -14,8 +14,8 @@ interface HighlightedValueCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [highlighted?](./search-ui-react.highlightedvaluecssclasses.highlighted.md) | string | (Optional) | -| [nonHighlighted?](./search-ui-react.highlightedvaluecssclasses.nonhighlighted.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [highlighted?](./search-ui-react.highlightedvaluecssclasses.highlighted.md) | | string | _(Optional)_ | +| [nonHighlighted?](./search-ui-react.highlightedvaluecssclasses.nonhighlighted.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.highlightedvaluecssclasses.nonhighlighted.md b/docs/search-ui-react.highlightedvaluecssclasses.nonhighlighted.md index e3e1af2a2..d45ba6228 100644 --- a/docs/search-ui-react.highlightedvaluecssclasses.nonhighlighted.md +++ b/docs/search-ui-react.highlightedvaluecssclasses.nonhighlighted.md @@ -4,7 +4,7 @@ ## HighlightedValueCssClasses.nonHighlighted property -Signature: +**Signature:** ```typescript nonHighlighted?: string; diff --git a/docs/search-ui-react.isctadata.md b/docs/search-ui-react.isctadata.md index 2f6c5f046..efae09e26 100644 --- a/docs/search-ui-react.isctadata.md +++ b/docs/search-ui-react.isctadata.md @@ -6,7 +6,7 @@ Type guard for CtaData. -Signature: +**Signature:** ```typescript declare function isCtaData(data: unknown): data is CtaData; @@ -18,9 +18,9 @@ declare function isCtaData(data: unknown): data is CtaData; | --- | --- | --- | | data | unknown | the data to validate. | -Returns: +**Returns:** -data is CtaData +data is [CtaData](./search-ui-react.ctadata.md) whether the data is of type CtaData. diff --git a/docs/search-ui-react.locationbias.md b/docs/search-ui-react.locationbias.md index 469f32222..e678226a5 100644 --- a/docs/search-ui-react.locationbias.md +++ b/docs/search-ui-react.locationbias.md @@ -11,7 +11,7 @@ A React Component which displays and collects location information in order to bias searches. -Signature: +**Signature:** ```typescript declare function LocationBias({ geolocationOptions, customCssClasses }: LocationBiasProps): JSX.Element | null; @@ -21,9 +21,9 @@ declare function LocationBias({ geolocationOptions, customCssClasses }: Location | Parameter | Type | Description | | --- | --- | --- | -| { geolocationOptions, customCssClasses } | LocationBiasProps | | +| { geolocationOptions, customCssClasses } | [LocationBiasProps](./search-ui-react.locationbiasprops.md) | | -Returns: +**Returns:** JSX.Element \| null diff --git a/docs/search-ui-react.locationbiascssclasses.button.md b/docs/search-ui-react.locationbiascssclasses.button.md index 597fde441..57cb2d248 100644 --- a/docs/search-ui-react.locationbiascssclasses.button.md +++ b/docs/search-ui-react.locationbiascssclasses.button.md @@ -4,7 +4,7 @@ ## LocationBiasCssClasses.button property -Signature: +**Signature:** ```typescript button?: string; diff --git a/docs/search-ui-react.locationbiascssclasses.loadingindicatorcontainer.md b/docs/search-ui-react.locationbiascssclasses.loadingindicatorcontainer.md index 5dd68c461..e79a46faf 100644 --- a/docs/search-ui-react.locationbiascssclasses.loadingindicatorcontainer.md +++ b/docs/search-ui-react.locationbiascssclasses.loadingindicatorcontainer.md @@ -4,7 +4,7 @@ ## LocationBiasCssClasses.loadingIndicatorContainer property -Signature: +**Signature:** ```typescript loadingIndicatorContainer?: string; diff --git a/docs/search-ui-react.locationbiascssclasses.location.md b/docs/search-ui-react.locationbiascssclasses.location.md index bc281a93f..9c491651f 100644 --- a/docs/search-ui-react.locationbiascssclasses.location.md +++ b/docs/search-ui-react.locationbiascssclasses.location.md @@ -4,7 +4,7 @@ ## LocationBiasCssClasses.location property -Signature: +**Signature:** ```typescript location?: string; diff --git a/docs/search-ui-react.locationbiascssclasses.locationbiascontainer.md b/docs/search-ui-react.locationbiascssclasses.locationbiascontainer.md index 056d64a6f..54b57cca5 100644 --- a/docs/search-ui-react.locationbiascssclasses.locationbiascontainer.md +++ b/docs/search-ui-react.locationbiascssclasses.locationbiascontainer.md @@ -4,7 +4,7 @@ ## LocationBiasCssClasses.locationBiasContainer property -Signature: +**Signature:** ```typescript locationBiasContainer?: string; diff --git a/docs/search-ui-react.locationbiascssclasses.md b/docs/search-ui-react.locationbiascssclasses.md index 9c7d31c65..6f7487d8d 100644 --- a/docs/search-ui-react.locationbiascssclasses.md +++ b/docs/search-ui-react.locationbiascssclasses.md @@ -11,7 +11,7 @@ The CSS class interface for the [LocationBias()](./search-ui-react.locationbias.md) component. -Signature: +**Signature:** ```typescript interface LocationBiasCssClasses @@ -19,11 +19,11 @@ interface LocationBiasCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [button?](./search-ui-react.locationbiascssclasses.button.md) | string | (Optional) | -| [loadingIndicatorContainer?](./search-ui-react.locationbiascssclasses.loadingindicatorcontainer.md) | string | (Optional) | -| [location?](./search-ui-react.locationbiascssclasses.location.md) | string | (Optional) | -| [locationBiasContainer?](./search-ui-react.locationbiascssclasses.locationbiascontainer.md) | string | (Optional) | -| [source?](./search-ui-react.locationbiascssclasses.source.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [button?](./search-ui-react.locationbiascssclasses.button.md) | | string | _(Optional)_ | +| [loadingIndicatorContainer?](./search-ui-react.locationbiascssclasses.loadingindicatorcontainer.md) | | string | _(Optional)_ | +| [location?](./search-ui-react.locationbiascssclasses.location.md) | | string | _(Optional)_ | +| [locationBiasContainer?](./search-ui-react.locationbiascssclasses.locationbiascontainer.md) | | string | _(Optional)_ | +| [source?](./search-ui-react.locationbiascssclasses.source.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.locationbiascssclasses.source.md b/docs/search-ui-react.locationbiascssclasses.source.md index 4d939b6bf..9d7ade299 100644 --- a/docs/search-ui-react.locationbiascssclasses.source.md +++ b/docs/search-ui-react.locationbiascssclasses.source.md @@ -4,7 +4,7 @@ ## LocationBiasCssClasses.source property -Signature: +**Signature:** ```typescript source?: string; diff --git a/docs/search-ui-react.locationbiasprops.customcssclasses.md b/docs/search-ui-react.locationbiasprops.customcssclasses.md index 12478877c..857e1cafb 100644 --- a/docs/search-ui-react.locationbiasprops.customcssclasses.md +++ b/docs/search-ui-react.locationbiasprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: LocationBiasCssClasses; diff --git a/docs/search-ui-react.locationbiasprops.geolocationoptions.md b/docs/search-ui-react.locationbiasprops.geolocationoptions.md index 642c3d46d..f33ba17af 100644 --- a/docs/search-ui-react.locationbiasprops.geolocationoptions.md +++ b/docs/search-ui-react.locationbiasprops.geolocationoptions.md @@ -6,7 +6,7 @@ Configuration used when collecting the user's location. Definition: [https://w3c.github.io/geolocation-api/\#position\_options\_interface](https://w3c.github.io/geolocation-api/#position_options_interface). -Signature: +**Signature:** ```typescript geolocationOptions?: PositionOptions; diff --git a/docs/search-ui-react.locationbiasprops.md b/docs/search-ui-react.locationbiasprops.md index 26944fdd2..c6bcc18c7 100644 --- a/docs/search-ui-react.locationbiasprops.md +++ b/docs/search-ui-react.locationbiasprops.md @@ -11,7 +11,7 @@ The props for the [LocationBias()](./search-ui-react.locationbias.md) component. -Signature: +**Signature:** ```typescript interface LocationBiasProps @@ -19,8 +19,8 @@ interface LocationBiasProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.locationbiasprops.customcssclasses.md) | LocationBiasCssClasses | (Optional) CSS classes for customizing the component styling. | -| [geolocationOptions?](./search-ui-react.locationbiasprops.geolocationoptions.md) | PositionOptions | (Optional) Configuration used when collecting the user's location. Definition: [https://w3c.github.io/geolocation-api/\#position\_options\_interface](https://w3c.github.io/geolocation-api/#position_options_interface). | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.locationbiasprops.customcssclasses.md) | | [LocationBiasCssClasses](./search-ui-react.locationbiascssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [geolocationOptions?](./search-ui-react.locationbiasprops.geolocationoptions.md) | | PositionOptions | _(Optional)_ Configuration used when collecting the user's location. Definition: [https://w3c.github.io/geolocation-api/\#position\_options\_interface](https://w3c.github.io/geolocation-api/#position_options_interface). | diff --git a/docs/search-ui-react.mapboxmap.md b/docs/search-ui-react.mapboxmap.md index e47f7cc94..a465ba1e2 100644 --- a/docs/search-ui-react.mapboxmap.md +++ b/docs/search-ui-react.mapboxmap.md @@ -6,21 +6,21 @@ A component that renders a map with markers to show result locations using Mapbox GL. -Signature: +**Signature:** ```typescript -declare function MapboxMap({ mapboxAccessToken, mapboxOptions, PinComponent, getCoordinate, onDrag }: MapboxMapProps): React.JSX.Element; +declare function MapboxMap({ mapboxAccessToken, mapboxOptions, PinComponent, getCoordinate, onDrag }: MapboxMapProps): JSX.Element; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| { mapboxAccessToken, mapboxOptions, PinComponent, getCoordinate, onDrag } | MapboxMapProps<T> | | +| { mapboxAccessToken, mapboxOptions, PinComponent, getCoordinate, onDrag } | [MapboxMapProps](./search-ui-react.mapboxmapprops.md)<T> | | -Returns: +**Returns:** -React.JSX.Element +JSX.Element A React element containing a Mapbox Map diff --git a/docs/search-ui-react.mapboxmapprops.getcoordinate.md b/docs/search-ui-react.mapboxmapprops.getcoordinate.md index 5b473cbcf..631c66e9a 100644 --- a/docs/search-ui-react.mapboxmapprops.getcoordinate.md +++ b/docs/search-ui-react.mapboxmapprops.getcoordinate.md @@ -6,7 +6,7 @@ A function to derive a result's coordinate for the corresponding marker's location on the map. By default, "yextDisplayCoordinate" field is used as the result's display coordinate. -Signature: +**Signature:** ```typescript getCoordinate?: CoordinateGetter; diff --git a/docs/search-ui-react.mapboxmapprops.mapboxaccesstoken.md b/docs/search-ui-react.mapboxmapprops.mapboxaccesstoken.md index 4eacc8558..64189cc43 100644 --- a/docs/search-ui-react.mapboxmapprops.mapboxaccesstoken.md +++ b/docs/search-ui-react.mapboxmapprops.mapboxaccesstoken.md @@ -6,7 +6,7 @@ Mapbox access token. -Signature: +**Signature:** ```typescript mapboxAccessToken: string; diff --git a/docs/search-ui-react.mapboxmapprops.mapboxoptions.md b/docs/search-ui-react.mapboxmapprops.mapboxoptions.md index 08c022f6b..16f89a96b 100644 --- a/docs/search-ui-react.mapboxmapprops.mapboxoptions.md +++ b/docs/search-ui-react.mapboxmapprops.mapboxoptions.md @@ -6,7 +6,7 @@ Interface for map customization derived from Mapbox GL's Map options. -Signature: +**Signature:** ```typescript mapboxOptions?: Omit; diff --git a/docs/search-ui-react.mapboxmapprops.md b/docs/search-ui-react.mapboxmapprops.md index 9a20d8827..186ce9d6b 100644 --- a/docs/search-ui-react.mapboxmapprops.md +++ b/docs/search-ui-react.mapboxmapprops.md @@ -6,7 +6,7 @@ Props for the [MapboxMap()](./search-ui-react.mapboxmap.md) component. The type param "T" represents the type of "rawData" field of the results use in the map. -Signature: +**Signature:** ```typescript interface MapboxMapProps @@ -14,11 +14,11 @@ interface MapboxMapProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [getCoordinate?](./search-ui-react.mapboxmapprops.getcoordinate.md) | CoordinateGetter<T> | (Optional) A function to derive a result's coordinate for the corresponding marker's location on the map. By default, "yextDisplayCoordinate" field is used as the result's display coordinate. | -| [mapboxAccessToken](./search-ui-react.mapboxmapprops.mapboxaccesstoken.md) | string | Mapbox access token. | -| [mapboxOptions?](./search-ui-react.mapboxmapprops.mapboxoptions.md) | Omit<mapboxgl.MapboxOptions, 'container'> | (Optional) Interface for map customization derived from Mapbox GL's Map options. | -| [onDrag?](./search-ui-react.mapboxmapprops.ondrag.md) | OnDragHandler | (Optional) A function which is called when user drag the map. | -| [PinComponent?](./search-ui-react.mapboxmapprops.pincomponent.md) | PinComponent<T> | (Optional) Custom Pin component to render for markers on the map. By default, the built-in marker image from Mapbox GL is used. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [getCoordinate?](./search-ui-react.mapboxmapprops.getcoordinate.md) | | [CoordinateGetter](./search-ui-react.coordinategetter.md)<T> | _(Optional)_ A function to derive a result's coordinate for the corresponding marker's location on the map. By default, "yextDisplayCoordinate" field is used as the result's display coordinate. | +| [mapboxAccessToken](./search-ui-react.mapboxmapprops.mapboxaccesstoken.md) | | string | Mapbox access token. | +| [mapboxOptions?](./search-ui-react.mapboxmapprops.mapboxoptions.md) | | Omit<mapboxgl.MapboxOptions, 'container'> | _(Optional)_ Interface for map customization derived from Mapbox GL's Map options. | +| [onDrag?](./search-ui-react.mapboxmapprops.ondrag.md) | | [OnDragHandler](./search-ui-react.ondraghandler.md) | _(Optional)_ A function which is called when user drag the map. | +| [PinComponent?](./search-ui-react.mapboxmapprops.pincomponent.md) | | [PinComponent](./search-ui-react.pincomponent.md)<T> | _(Optional)_ Custom Pin component to render for markers on the map. By default, the built-in marker image from Mapbox GL is used. | diff --git a/docs/search-ui-react.mapboxmapprops.ondrag.md b/docs/search-ui-react.mapboxmapprops.ondrag.md index 1da45cba7..e5f0133fd 100644 --- a/docs/search-ui-react.mapboxmapprops.ondrag.md +++ b/docs/search-ui-react.mapboxmapprops.ondrag.md @@ -6,7 +6,7 @@ A function which is called when user drag the map. -Signature: +**Signature:** ```typescript onDrag?: OnDragHandler; diff --git a/docs/search-ui-react.mapboxmapprops.pincomponent.md b/docs/search-ui-react.mapboxmapprops.pincomponent.md index 8f7251ba4..e6022b268 100644 --- a/docs/search-ui-react.mapboxmapprops.pincomponent.md +++ b/docs/search-ui-react.mapboxmapprops.pincomponent.md @@ -6,7 +6,7 @@ Custom Pin component to render for markers on the map. By default, the built-in marker image from Mapbox GL is used. -Signature: +**Signature:** ```typescript PinComponent?: PinComponent; diff --git a/docs/search-ui-react.numericalfacet.md b/docs/search-ui-react.numericalfacet.md index 756ae151f..7f333c9b4 100644 --- a/docs/search-ui-react.numericalfacet.md +++ b/docs/search-ui-react.numericalfacet.md @@ -6,7 +6,7 @@ A component that displays a single numerical facet. Use this to override the default rendering. -Signature: +**Signature:** ```typescript declare function NumericalFacet(props: NumericalFacetProps): null; @@ -16,9 +16,9 @@ declare function NumericalFacet(props: NumericalFacetProps): null; | Parameter | Type | Description | | --- | --- | --- | -| props | NumericalFacetProps | [NumericalFacetProps](./search-ui-react.numericalfacetprops.md) | +| props | [NumericalFacetProps](./search-ui-react.numericalfacetprops.md) | [NumericalFacetProps](./search-ui-react.numericalfacetprops.md) | -Returns: +**Returns:** null diff --git a/docs/search-ui-react.numericalfacetprops.customcssclasses.md b/docs/search-ui-react.numericalfacetprops.customcssclasses.md index 602d8a32c..ff7c83ce4 100644 --- a/docs/search-ui-react.numericalfacetprops.customcssclasses.md +++ b/docs/search-ui-react.numericalfacetprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: FilterGroupCssClasses & RangeInputCssClasses; diff --git a/docs/search-ui-react.numericalfacetprops.getfilterdisplayname.md b/docs/search-ui-react.numericalfacetprops.getfilterdisplayname.md index 6f4034e70..a33de3c8e 100644 --- a/docs/search-ui-react.numericalfacetprops.getfilterdisplayname.md +++ b/docs/search-ui-react.numericalfacetprops.getfilterdisplayname.md @@ -6,7 +6,7 @@ Returns the filter's display name based on the range values which is used when the filter is displayed by other components such as AppliedFilters. -Signature: +**Signature:** ```typescript getFilterDisplayName?: (value: NumberRangeValue) => string; diff --git a/docs/search-ui-react.numericalfacetprops.inputprefix.md b/docs/search-ui-react.numericalfacetprops.inputprefix.md index 50b0b3877..74182c6a0 100644 --- a/docs/search-ui-react.numericalfacetprops.inputprefix.md +++ b/docs/search-ui-react.numericalfacetprops.inputprefix.md @@ -6,7 +6,7 @@ An optional element which renders in front of the input text. -Signature: +**Signature:** ```typescript inputPrefix?: JSX.Element; diff --git a/docs/search-ui-react.numericalfacetprops.md b/docs/search-ui-react.numericalfacetprops.md index da7650bc2..f7e06bb27 100644 --- a/docs/search-ui-react.numericalfacetprops.md +++ b/docs/search-ui-react.numericalfacetprops.md @@ -6,19 +6,19 @@ Props for the [StandardFacet()](./search-ui-react.standardfacet.md) component. -Signature: +**Signature:** ```typescript interface NumericalFacetProps extends StandardFacetProps ``` -Extends: StandardFacetProps +**Extends:** [StandardFacetProps](./search-ui-react.standardfacetprops.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.numericalfacetprops.customcssclasses.md) | FilterGroupCssClasses & RangeInputCssClasses | (Optional) CSS classes for customizing the component styling. | -| [getFilterDisplayName?](./search-ui-react.numericalfacetprops.getfilterdisplayname.md) | (value: NumberRangeValue) => string | (Optional) Returns the filter's display name based on the range values which is used when the filter is displayed by other components such as AppliedFilters. | -| [inputPrefix?](./search-ui-react.numericalfacetprops.inputprefix.md) | JSX.Element | (Optional) An optional element which renders in front of the input text. | -| [showOptionCounts?](./search-ui-react.numericalfacetprops.showoptioncounts.md) | boolean | (Optional) Whether or not to show the option counts for each filter. Defaults to false. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.numericalfacetprops.customcssclasses.md) | | [FilterGroupCssClasses](./search-ui-react.filtergroupcssclasses.md) & [RangeInputCssClasses](./search-ui-react.rangeinputcssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [getFilterDisplayName?](./search-ui-react.numericalfacetprops.getfilterdisplayname.md) | | (value: NumberRangeValue) => string | _(Optional)_ Returns the filter's display name based on the range values which is used when the filter is displayed by other components such as AppliedFilters. | +| [inputPrefix?](./search-ui-react.numericalfacetprops.inputprefix.md) | | JSX.Element | _(Optional)_ An optional element which renders in front of the input text. | +| [showOptionCounts?](./search-ui-react.numericalfacetprops.showoptioncounts.md) | | boolean | _(Optional)_ Whether or not to show the option counts for each filter. Defaults to false. | diff --git a/docs/search-ui-react.numericalfacetprops.showoptioncounts.md b/docs/search-ui-react.numericalfacetprops.showoptioncounts.md index 8f510813b..b66de2042 100644 --- a/docs/search-ui-react.numericalfacetprops.showoptioncounts.md +++ b/docs/search-ui-react.numericalfacetprops.showoptioncounts.md @@ -6,7 +6,7 @@ Whether or not to show the option counts for each filter. Defaults to false. -Signature: +**Signature:** ```typescript showOptionCounts?: boolean; diff --git a/docs/search-ui-react.numericalfacets.md b/docs/search-ui-react.numericalfacets.md index 3c49ab129..7e505f946 100644 --- a/docs/search-ui-react.numericalfacets.md +++ b/docs/search-ui-react.numericalfacets.md @@ -11,21 +11,21 @@ A component that displays numerical facets applicable to the current vertical search. -Signature: +**Signature:** ```typescript -declare function NumericalFacets({ searchOnChange, includedFieldIds, getFilterDisplayName, inputPrefix, customCssClasses, ...filterGroupProps }: NumericalFacetsProps): React.JSX.Element; +declare function NumericalFacets({ searchOnChange, includedFieldIds, getFilterDisplayName, inputPrefix, customCssClasses, ...filterGroupProps }: NumericalFacetsProps): JSX.Element; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| { searchOnChange, includedFieldIds, getFilterDisplayName, inputPrefix, customCssClasses, ...filterGroupProps } | NumericalFacetsProps | | +| { searchOnChange, includedFieldIds, getFilterDisplayName, inputPrefix, customCssClasses, ...filterGroupProps } | [NumericalFacetsProps](./search-ui-react.numericalfacetsprops.md) | | -Returns: +**Returns:** -React.JSX.Element +JSX.Element A React component for facets diff --git a/docs/search-ui-react.numericalfacetscssclasses.divider.md b/docs/search-ui-react.numericalfacetscssclasses.divider.md index 66927f1d2..463ad5bc8 100644 --- a/docs/search-ui-react.numericalfacetscssclasses.divider.md +++ b/docs/search-ui-react.numericalfacetscssclasses.divider.md @@ -4,7 +4,7 @@ ## NumericalFacetsCssClasses.divider property -Signature: +**Signature:** ```typescript divider?: string; diff --git a/docs/search-ui-react.numericalfacetscssclasses.md b/docs/search-ui-react.numericalfacetscssclasses.md index 7b3176361..7700075e4 100644 --- a/docs/search-ui-react.numericalfacetscssclasses.md +++ b/docs/search-ui-react.numericalfacetscssclasses.md @@ -6,17 +6,17 @@ The CSS class interface for [NumericalFacets()](./search-ui-react.numericalfacets.md). -Signature: +**Signature:** ```typescript interface NumericalFacetsCssClasses extends FilterGroupCssClasses, RangeInputCssClasses ``` -Extends: FilterGroupCssClasses, RangeInputCssClasses +**Extends:** [FilterGroupCssClasses](./search-ui-react.filtergroupcssclasses.md), [RangeInputCssClasses](./search-ui-react.rangeinputcssclasses.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [divider?](./search-ui-react.numericalfacetscssclasses.divider.md) | string | (Optional) | -| [numericalFacetsContainer?](./search-ui-react.numericalfacetscssclasses.numericalfacetscontainer.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [divider?](./search-ui-react.numericalfacetscssclasses.divider.md) | | string | _(Optional)_ | +| [numericalFacetsContainer?](./search-ui-react.numericalfacetscssclasses.numericalfacetscontainer.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.numericalfacetscssclasses.numericalfacetscontainer.md b/docs/search-ui-react.numericalfacetscssclasses.numericalfacetscontainer.md index b33a74f69..14a50268b 100644 --- a/docs/search-ui-react.numericalfacetscssclasses.numericalfacetscontainer.md +++ b/docs/search-ui-react.numericalfacetscssclasses.numericalfacetscontainer.md @@ -4,7 +4,7 @@ ## NumericalFacetsCssClasses.numericalFacetsContainer property -Signature: +**Signature:** ```typescript numericalFacetsContainer?: string; diff --git a/docs/search-ui-react.numericalfacetsprops.customcssclasses.md b/docs/search-ui-react.numericalfacetsprops.customcssclasses.md index 0dc1e2ad3..e2149a2ed 100644 --- a/docs/search-ui-react.numericalfacetsprops.customcssclasses.md +++ b/docs/search-ui-react.numericalfacetsprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: NumericalFacetsCssClasses; diff --git a/docs/search-ui-react.numericalfacetsprops.getfilterdisplayname.md b/docs/search-ui-react.numericalfacetsprops.getfilterdisplayname.md index 6dec73c47..860bb88b8 100644 --- a/docs/search-ui-react.numericalfacetsprops.getfilterdisplayname.md +++ b/docs/search-ui-react.numericalfacetsprops.getfilterdisplayname.md @@ -6,7 +6,7 @@ Returns the filter's display name based on the range values which is used when the filter is displayed by other components such as AppliedFilters. -Signature: +**Signature:** ```typescript getFilterDisplayName?: (value: NumberRangeValue) => string; diff --git a/docs/search-ui-react.numericalfacetsprops.includedfieldids.md b/docs/search-ui-react.numericalfacetsprops.includedfieldids.md index dbac1271d..e6abf54e7 100644 --- a/docs/search-ui-react.numericalfacetsprops.includedfieldids.md +++ b/docs/search-ui-react.numericalfacetsprops.includedfieldids.md @@ -6,7 +6,7 @@ List of filter ids to render as numerical facets. -Signature: +**Signature:** ```typescript includedFieldIds?: string[]; diff --git a/docs/search-ui-react.numericalfacetsprops.inputprefix.md b/docs/search-ui-react.numericalfacetsprops.inputprefix.md index c93af1cfb..23b0af540 100644 --- a/docs/search-ui-react.numericalfacetsprops.inputprefix.md +++ b/docs/search-ui-react.numericalfacetsprops.inputprefix.md @@ -6,7 +6,7 @@ An optional element which renders in front of the input text. -Signature: +**Signature:** ```typescript inputPrefix?: JSX.Element; diff --git a/docs/search-ui-react.numericalfacetsprops.md b/docs/search-ui-react.numericalfacetsprops.md index c13f3ab91..63bfc9914 100644 --- a/docs/search-ui-react.numericalfacetsprops.md +++ b/docs/search-ui-react.numericalfacetsprops.md @@ -11,19 +11,19 @@ Props for the [NumericalFacets()](./search-ui-react.numericalfacets.md) component. -Signature: +**Signature:** ```typescript interface NumericalFacetsProps extends Omit ``` -Extends: Omit<StandardFacetsProps, 'excludedFieldIds'> +**Extends:** Omit<[StandardFacetsProps](./search-ui-react.standardfacetsprops.md), 'excludedFieldIds'> ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.numericalfacetsprops.customcssclasses.md) | NumericalFacetsCssClasses | (Optional) CSS classes for customizing the component styling. | -| [getFilterDisplayName?](./search-ui-react.numericalfacetsprops.getfilterdisplayname.md) | (value: NumberRangeValue) => string | (Optional) Returns the filter's display name based on the range values which is used when the filter is displayed by other components such as AppliedFilters. | -| [includedFieldIds?](./search-ui-react.numericalfacetsprops.includedfieldids.md) | string\[\] | (Optional) List of filter ids to render as numerical facets. | -| [inputPrefix?](./search-ui-react.numericalfacetsprops.inputprefix.md) | JSX.Element | (Optional) An optional element which renders in front of the input text. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.numericalfacetsprops.customcssclasses.md) | | [NumericalFacetsCssClasses](./search-ui-react.numericalfacetscssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [getFilterDisplayName?](./search-ui-react.numericalfacetsprops.getfilterdisplayname.md) | | (value: NumberRangeValue) => string | _(Optional)_ Returns the filter's display name based on the range values which is used when the filter is displayed by other components such as AppliedFilters. | +| [includedFieldIds?](./search-ui-react.numericalfacetsprops.includedfieldids.md) | | string\[\] | _(Optional)_ List of filter ids to render as numerical facets. | +| [inputPrefix?](./search-ui-react.numericalfacetsprops.inputprefix.md) | | JSX.Element | _(Optional)_ An optional element which renders in front of the input text. | diff --git a/docs/search-ui-react.ondraghandler.md b/docs/search-ui-react.ondraghandler.md index 0c9cccdd5..e737d7b1a 100644 --- a/docs/search-ui-react.ondraghandler.md +++ b/docs/search-ui-react.ondraghandler.md @@ -6,7 +6,7 @@ A function which is called when user drag the map. -Signature: +**Signature:** ```typescript type OnDragHandler = (center: mapboxgl.LngLat, bounds: mapboxgl.LngLatBounds) => void; diff --git a/docs/search-ui-react.onsearchfunc.md b/docs/search-ui-react.onsearchfunc.md index f8d0ff7b7..82e43adff 100644 --- a/docs/search-ui-react.onsearchfunc.md +++ b/docs/search-ui-react.onsearchfunc.md @@ -6,7 +6,7 @@ The interface of a function which is called on a search. -Signature: +**Signature:** ```typescript type onSearchFunc = (searchEventData: { diff --git a/docs/search-ui-react.onselectparams.currentfilter.md b/docs/search-ui-react.onselectparams.currentfilter.md index e72f10ff1..8ac4669f5 100644 --- a/docs/search-ui-react.onselectparams.currentfilter.md +++ b/docs/search-ui-react.onselectparams.currentfilter.md @@ -6,7 +6,7 @@ The previously selected filter. -Signature: +**Signature:** ```typescript currentFilter: StaticFilter | undefined; diff --git a/docs/search-ui-react.onselectparams.executefiltersearch.md b/docs/search-ui-react.onselectparams.executefiltersearch.md index ac7720e64..caab8c5c1 100644 --- a/docs/search-ui-react.onselectparams.executefiltersearch.md +++ b/docs/search-ui-react.onselectparams.executefiltersearch.md @@ -6,7 +6,7 @@ A function that executes a filter search and updates the input and dropdown options with the response. -Signature: +**Signature:** ```typescript executeFilterSearch: (query?: string) => Promise; diff --git a/docs/search-ui-react.onselectparams.md b/docs/search-ui-react.onselectparams.md index d51a0c9fb..5a51f10e6 100644 --- a/docs/search-ui-react.onselectparams.md +++ b/docs/search-ui-react.onselectparams.md @@ -6,7 +6,7 @@ The parameters that are passed into [FilterSearchProps.onSelect](./search-ui-react.filtersearchprops.onselect.md). -Signature: +**Signature:** ```typescript interface OnSelectParams @@ -14,11 +14,11 @@ interface OnSelectParams ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [currentFilter](./search-ui-react.onselectparams.currentfilter.md) | StaticFilter \| undefined | The previously selected filter. | -| [executeFilterSearch](./search-ui-react.onselectparams.executefiltersearch.md) | (query?: string) => Promise<FilterSearchResponse \| undefined> | A function that executes a filter search and updates the input and dropdown options with the response. | -| [newDisplayName](./search-ui-react.onselectparams.newdisplayname.md) | string | The display name of the newly selected filter. | -| [newFilter](./search-ui-react.onselectparams.newfilter.md) | FieldValueStaticFilter | The newly selected filter. | -| [setCurrentFilter](./search-ui-react.onselectparams.setcurrentfilter.md) | (filter: StaticFilter) => void | A function that sets which filter the component is currently associated with. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [currentFilter](./search-ui-react.onselectparams.currentfilter.md) | | StaticFilter \| undefined | The previously selected filter. | +| [executeFilterSearch](./search-ui-react.onselectparams.executefiltersearch.md) | | (query?: string) => Promise<FilterSearchResponse \| undefined> | A function that executes a filter search and updates the input and dropdown options with the response. | +| [newDisplayName](./search-ui-react.onselectparams.newdisplayname.md) | | string | The display name of the newly selected filter. | +| [newFilter](./search-ui-react.onselectparams.newfilter.md) | | FieldValueStaticFilter | The newly selected filter. | +| [setCurrentFilter](./search-ui-react.onselectparams.setcurrentfilter.md) | | (filter: StaticFilter) => void | A function that sets which filter the component is currently associated with. | diff --git a/docs/search-ui-react.onselectparams.newdisplayname.md b/docs/search-ui-react.onselectparams.newdisplayname.md index f47f95d6a..e9dc67dc1 100644 --- a/docs/search-ui-react.onselectparams.newdisplayname.md +++ b/docs/search-ui-react.onselectparams.newdisplayname.md @@ -6,7 +6,7 @@ The display name of the newly selected filter. -Signature: +**Signature:** ```typescript newDisplayName: string; diff --git a/docs/search-ui-react.onselectparams.newfilter.md b/docs/search-ui-react.onselectparams.newfilter.md index ff9ddae77..3679bcf8e 100644 --- a/docs/search-ui-react.onselectparams.newfilter.md +++ b/docs/search-ui-react.onselectparams.newfilter.md @@ -6,7 +6,7 @@ The newly selected filter. -Signature: +**Signature:** ```typescript newFilter: FieldValueStaticFilter; diff --git a/docs/search-ui-react.onselectparams.setcurrentfilter.md b/docs/search-ui-react.onselectparams.setcurrentfilter.md index 90356f104..a555b11b8 100644 --- a/docs/search-ui-react.onselectparams.setcurrentfilter.md +++ b/docs/search-ui-react.onselectparams.setcurrentfilter.md @@ -6,7 +6,7 @@ A function that sets which filter the component is currently associated with. -Signature: +**Signature:** ```typescript setCurrentFilter: (filter: StaticFilter) => void; diff --git a/docs/search-ui-react.pagination.md b/docs/search-ui-react.pagination.md index 33bc1918d..647fbd9d0 100644 --- a/docs/search-ui-react.pagination.md +++ b/docs/search-ui-react.pagination.md @@ -6,7 +6,7 @@ Renders a component that divide a series of vertical results into chunks across multiple pages and enable user to navigate between those pages. -Signature: +**Signature:** ```typescript declare function Pagination(props: PaginationProps): JSX.Element | null; @@ -16,9 +16,9 @@ declare function Pagination(props: PaginationProps): JSX.Element | null; | Parameter | Type | Description | | --- | --- | --- | -| props | PaginationProps | | +| props | [PaginationProps](./search-ui-react.paginationprops.md) | | -Returns: +**Returns:** JSX.Element \| null diff --git a/docs/search-ui-react.paginationcssclasses.icon.md b/docs/search-ui-react.paginationcssclasses.icon.md index 6eecaa09e..141cb2cbc 100644 --- a/docs/search-ui-react.paginationcssclasses.icon.md +++ b/docs/search-ui-react.paginationcssclasses.icon.md @@ -4,7 +4,7 @@ ## PaginationCssClasses.icon property -Signature: +**Signature:** ```typescript icon?: string; diff --git a/docs/search-ui-react.paginationcssclasses.label.md b/docs/search-ui-react.paginationcssclasses.label.md index efca3f17a..46e709d8a 100644 --- a/docs/search-ui-react.paginationcssclasses.label.md +++ b/docs/search-ui-react.paginationcssclasses.label.md @@ -4,7 +4,7 @@ ## PaginationCssClasses.label property -Signature: +**Signature:** ```typescript label?: string; diff --git a/docs/search-ui-react.paginationcssclasses.lefticoncontainer.md b/docs/search-ui-react.paginationcssclasses.lefticoncontainer.md index f77685ed8..ed9c8a01f 100644 --- a/docs/search-ui-react.paginationcssclasses.lefticoncontainer.md +++ b/docs/search-ui-react.paginationcssclasses.lefticoncontainer.md @@ -4,7 +4,7 @@ ## PaginationCssClasses.leftIconContainer property -Signature: +**Signature:** ```typescript leftIconContainer?: string; diff --git a/docs/search-ui-react.paginationcssclasses.md b/docs/search-ui-react.paginationcssclasses.md index ef2b61972..4dfbf557b 100644 --- a/docs/search-ui-react.paginationcssclasses.md +++ b/docs/search-ui-react.paginationcssclasses.md @@ -6,7 +6,7 @@ The CSS classes used for pagination. -Signature: +**Signature:** ```typescript interface PaginationCssClasses @@ -14,13 +14,13 @@ interface PaginationCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [icon?](./search-ui-react.paginationcssclasses.icon.md) | string | (Optional) | -| [label?](./search-ui-react.paginationcssclasses.label.md) | string | (Optional) | -| [leftIconContainer?](./search-ui-react.paginationcssclasses.lefticoncontainer.md) | string | (Optional) | -| [paginationContainer?](./search-ui-react.paginationcssclasses.paginationcontainer.md) | string | (Optional) | -| [paginationLoading?](./search-ui-react.paginationcssclasses.paginationloading.md) | string | (Optional) | -| [rightIconContainer?](./search-ui-react.paginationcssclasses.righticoncontainer.md) | string | (Optional) | -| [selectedLabel?](./search-ui-react.paginationcssclasses.selectedlabel.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [icon?](./search-ui-react.paginationcssclasses.icon.md) | | string | _(Optional)_ | +| [label?](./search-ui-react.paginationcssclasses.label.md) | | string | _(Optional)_ | +| [leftIconContainer?](./search-ui-react.paginationcssclasses.lefticoncontainer.md) | | string | _(Optional)_ | +| [paginationContainer?](./search-ui-react.paginationcssclasses.paginationcontainer.md) | | string | _(Optional)_ | +| [paginationLoading?](./search-ui-react.paginationcssclasses.paginationloading.md) | | string | _(Optional)_ | +| [rightIconContainer?](./search-ui-react.paginationcssclasses.righticoncontainer.md) | | string | _(Optional)_ | +| [selectedLabel?](./search-ui-react.paginationcssclasses.selectedlabel.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.paginationcssclasses.paginationcontainer.md b/docs/search-ui-react.paginationcssclasses.paginationcontainer.md index 2ddb6154f..ae3fd338d 100644 --- a/docs/search-ui-react.paginationcssclasses.paginationcontainer.md +++ b/docs/search-ui-react.paginationcssclasses.paginationcontainer.md @@ -4,7 +4,7 @@ ## PaginationCssClasses.paginationContainer property -Signature: +**Signature:** ```typescript paginationContainer?: string; diff --git a/docs/search-ui-react.paginationcssclasses.paginationloading.md b/docs/search-ui-react.paginationcssclasses.paginationloading.md index d2eb9b603..311e9d63b 100644 --- a/docs/search-ui-react.paginationcssclasses.paginationloading.md +++ b/docs/search-ui-react.paginationcssclasses.paginationloading.md @@ -4,7 +4,7 @@ ## PaginationCssClasses.paginationLoading property -Signature: +**Signature:** ```typescript paginationLoading?: string; diff --git a/docs/search-ui-react.paginationcssclasses.righticoncontainer.md b/docs/search-ui-react.paginationcssclasses.righticoncontainer.md index d0a86ad33..7be8697fb 100644 --- a/docs/search-ui-react.paginationcssclasses.righticoncontainer.md +++ b/docs/search-ui-react.paginationcssclasses.righticoncontainer.md @@ -4,7 +4,7 @@ ## PaginationCssClasses.rightIconContainer property -Signature: +**Signature:** ```typescript rightIconContainer?: string; diff --git a/docs/search-ui-react.paginationcssclasses.selectedlabel.md b/docs/search-ui-react.paginationcssclasses.selectedlabel.md index 06f3e68b4..3787c9913 100644 --- a/docs/search-ui-react.paginationcssclasses.selectedlabel.md +++ b/docs/search-ui-react.paginationcssclasses.selectedlabel.md @@ -4,7 +4,7 @@ ## PaginationCssClasses.selectedLabel property -Signature: +**Signature:** ```typescript selectedLabel?: string; diff --git a/docs/search-ui-react.paginationprops.customcssclasses.md b/docs/search-ui-react.paginationprops.customcssclasses.md index 960d18d60..7aa0d9adb 100644 --- a/docs/search-ui-react.paginationprops.customcssclasses.md +++ b/docs/search-ui-react.paginationprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: PaginationCssClasses; diff --git a/docs/search-ui-react.paginationprops.md b/docs/search-ui-react.paginationprops.md index a6c754486..62005c623 100644 --- a/docs/search-ui-react.paginationprops.md +++ b/docs/search-ui-react.paginationprops.md @@ -6,7 +6,7 @@ Props for [Pagination()](./search-ui-react.pagination.md) component -Signature: +**Signature:** ```typescript interface PaginationProps @@ -14,8 +14,8 @@ interface PaginationProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.paginationprops.customcssclasses.md) | PaginationCssClasses | (Optional) CSS classes for customizing the component styling. | -| [paginateAllOnNoResults?](./search-ui-react.paginationprops.paginateallonnoresults.md) | boolean | (Optional) Whether or not to paginate based on the total results count of the vertical when there are none returned from the search. Defaults to false. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.paginationprops.customcssclasses.md) | | [PaginationCssClasses](./search-ui-react.paginationcssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [paginateAllOnNoResults?](./search-ui-react.paginationprops.paginateallonnoresults.md) | | boolean | _(Optional)_ Whether or not to paginate based on the total results count of the vertical when there are none returned from the search. Defaults to false. | diff --git a/docs/search-ui-react.paginationprops.paginateallonnoresults.md b/docs/search-ui-react.paginationprops.paginateallonnoresults.md index ce65bfcc1..c4438e0c7 100644 --- a/docs/search-ui-react.paginationprops.paginateallonnoresults.md +++ b/docs/search-ui-react.paginationprops.paginateallonnoresults.md @@ -6,7 +6,7 @@ Whether or not to paginate based on the total results count of the vertical when there are none returned from the search. Defaults to false. -Signature: +**Signature:** ```typescript paginateAllOnNoResults?: boolean; diff --git a/docs/search-ui-react.pincomponent.md b/docs/search-ui-react.pincomponent.md index a9fd7e1ea..45fa47893 100644 --- a/docs/search-ui-react.pincomponent.md +++ b/docs/search-ui-react.pincomponent.md @@ -6,7 +6,7 @@ A functional component that can be used to render a custom marker on the map. -Signature: +**Signature:** ```typescript type PinComponent = (props: { diff --git a/docs/search-ui-react.rangeinputcssclasses.applybutton.md b/docs/search-ui-react.rangeinputcssclasses.applybutton.md index f731bee71..e37c0f9ea 100644 --- a/docs/search-ui-react.rangeinputcssclasses.applybutton.md +++ b/docs/search-ui-react.rangeinputcssclasses.applybutton.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.applyButton property -Signature: +**Signature:** ```typescript applyButton?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.buttonscontainer.md b/docs/search-ui-react.rangeinputcssclasses.buttonscontainer.md index f8f8988a7..faa34b69e 100644 --- a/docs/search-ui-react.rangeinputcssclasses.buttonscontainer.md +++ b/docs/search-ui-react.rangeinputcssclasses.buttonscontainer.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.buttonsContainer property -Signature: +**Signature:** ```typescript buttonsContainer?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.clearbutton.md b/docs/search-ui-react.rangeinputcssclasses.clearbutton.md index a54b3ae77..ad56fbd5a 100644 --- a/docs/search-ui-react.rangeinputcssclasses.clearbutton.md +++ b/docs/search-ui-react.rangeinputcssclasses.clearbutton.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.clearButton property -Signature: +**Signature:** ```typescript clearButton?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.input.md b/docs/search-ui-react.rangeinputcssclasses.input.md index 097e5d89f..70f6eb7c1 100644 --- a/docs/search-ui-react.rangeinputcssclasses.input.md +++ b/docs/search-ui-react.rangeinputcssclasses.input.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.input property -Signature: +**Signature:** ```typescript input?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.input___disabled.md b/docs/search-ui-react.rangeinputcssclasses.input___disabled.md index bcea45b31..e36a20a1e 100644 --- a/docs/search-ui-react.rangeinputcssclasses.input___disabled.md +++ b/docs/search-ui-react.rangeinputcssclasses.input___disabled.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.input\_\_\_disabled property -Signature: +**Signature:** ```typescript input___disabled?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.input___enabled.md b/docs/search-ui-react.rangeinputcssclasses.input___enabled.md index fb8950c19..f701b81ef 100644 --- a/docs/search-ui-react.rangeinputcssclasses.input___enabled.md +++ b/docs/search-ui-react.rangeinputcssclasses.input___enabled.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.input\_\_\_enabled property -Signature: +**Signature:** ```typescript input___enabled?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.input___invalid.md b/docs/search-ui-react.rangeinputcssclasses.input___invalid.md index ef10403c2..48deca4f3 100644 --- a/docs/search-ui-react.rangeinputcssclasses.input___invalid.md +++ b/docs/search-ui-react.rangeinputcssclasses.input___invalid.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.input\_\_\_invalid property -Signature: +**Signature:** ```typescript input___invalid?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.input___valid.md b/docs/search-ui-react.rangeinputcssclasses.input___valid.md index ffeebad29..f78184b21 100644 --- a/docs/search-ui-react.rangeinputcssclasses.input___valid.md +++ b/docs/search-ui-react.rangeinputcssclasses.input___valid.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.input\_\_\_valid property -Signature: +**Signature:** ```typescript input___valid?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.input___withoutprefix.md b/docs/search-ui-react.rangeinputcssclasses.input___withoutprefix.md index 804ceb673..b5ed4da7e 100644 --- a/docs/search-ui-react.rangeinputcssclasses.input___withoutprefix.md +++ b/docs/search-ui-react.rangeinputcssclasses.input___withoutprefix.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.input\_\_\_withoutPrefix property -Signature: +**Signature:** ```typescript input___withoutPrefix?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.input___withprefix.md b/docs/search-ui-react.rangeinputcssclasses.input___withprefix.md index 68b90e421..b996c966c 100644 --- a/docs/search-ui-react.rangeinputcssclasses.input___withprefix.md +++ b/docs/search-ui-react.rangeinputcssclasses.input___withprefix.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.input\_\_\_withPrefix property -Signature: +**Signature:** ```typescript input___withPrefix?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.inputcontainer.md b/docs/search-ui-react.rangeinputcssclasses.inputcontainer.md index d2bfa636c..444e0c30c 100644 --- a/docs/search-ui-react.rangeinputcssclasses.inputcontainer.md +++ b/docs/search-ui-react.rangeinputcssclasses.inputcontainer.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.inputContainer property -Signature: +**Signature:** ```typescript inputContainer?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.inputprefix.md b/docs/search-ui-react.rangeinputcssclasses.inputprefix.md index 48d064f9e..d8b64f3ae 100644 --- a/docs/search-ui-react.rangeinputcssclasses.inputprefix.md +++ b/docs/search-ui-react.rangeinputcssclasses.inputprefix.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.inputPrefix property -Signature: +**Signature:** ```typescript inputPrefix?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.inputprefix___disabled.md b/docs/search-ui-react.rangeinputcssclasses.inputprefix___disabled.md index ad7cb5c22..f9fad8073 100644 --- a/docs/search-ui-react.rangeinputcssclasses.inputprefix___disabled.md +++ b/docs/search-ui-react.rangeinputcssclasses.inputprefix___disabled.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.inputPrefix\_\_\_disabled property -Signature: +**Signature:** ```typescript inputPrefix___disabled?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.inputprefix___enabled.md b/docs/search-ui-react.rangeinputcssclasses.inputprefix___enabled.md index 48aeb3a17..c2557bc9e 100644 --- a/docs/search-ui-react.rangeinputcssclasses.inputprefix___enabled.md +++ b/docs/search-ui-react.rangeinputcssclasses.inputprefix___enabled.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.inputPrefix\_\_\_enabled property -Signature: +**Signature:** ```typescript inputPrefix___enabled?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.inputrowcontainer.md b/docs/search-ui-react.rangeinputcssclasses.inputrowcontainer.md index 93d970bd0..f3ddff331 100644 --- a/docs/search-ui-react.rangeinputcssclasses.inputrowcontainer.md +++ b/docs/search-ui-react.rangeinputcssclasses.inputrowcontainer.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.inputRowContainer property -Signature: +**Signature:** ```typescript inputRowContainer?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.invalidmessage.md b/docs/search-ui-react.rangeinputcssclasses.invalidmessage.md index c16924d10..97369b0eb 100644 --- a/docs/search-ui-react.rangeinputcssclasses.invalidmessage.md +++ b/docs/search-ui-react.rangeinputcssclasses.invalidmessage.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.invalidMessage property -Signature: +**Signature:** ```typescript invalidMessage?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.invalidrowcontainer.md b/docs/search-ui-react.rangeinputcssclasses.invalidrowcontainer.md index 2eced9322..d4b280eb3 100644 --- a/docs/search-ui-react.rangeinputcssclasses.invalidrowcontainer.md +++ b/docs/search-ui-react.rangeinputcssclasses.invalidrowcontainer.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.invalidRowContainer property -Signature: +**Signature:** ```typescript invalidRowContainer?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.md b/docs/search-ui-react.rangeinputcssclasses.md index dc5f55ac0..b33aea125 100644 --- a/docs/search-ui-react.rangeinputcssclasses.md +++ b/docs/search-ui-react.rangeinputcssclasses.md @@ -6,7 +6,7 @@ The CSS class interface for RangeInput. -Signature: +**Signature:** ```typescript interface RangeInputCssClasses @@ -14,26 +14,26 @@ interface RangeInputCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [applyButton?](./search-ui-react.rangeinputcssclasses.applybutton.md) | string | (Optional) | -| [buttonsContainer?](./search-ui-react.rangeinputcssclasses.buttonscontainer.md) | string | (Optional) | -| [clearButton?](./search-ui-react.rangeinputcssclasses.clearbutton.md) | string | (Optional) | -| [input\_\_\_disabled?](./search-ui-react.rangeinputcssclasses.input___disabled.md) | string | (Optional) | -| [input\_\_\_enabled?](./search-ui-react.rangeinputcssclasses.input___enabled.md) | string | (Optional) | -| [input\_\_\_invalid?](./search-ui-react.rangeinputcssclasses.input___invalid.md) | string | (Optional) | -| [input\_\_\_valid?](./search-ui-react.rangeinputcssclasses.input___valid.md) | string | (Optional) | -| [input\_\_\_withoutPrefix?](./search-ui-react.rangeinputcssclasses.input___withoutprefix.md) | string | (Optional) | -| [input\_\_\_withPrefix?](./search-ui-react.rangeinputcssclasses.input___withprefix.md) | string | (Optional) | -| [input?](./search-ui-react.rangeinputcssclasses.input.md) | string | (Optional) | -| [inputContainer?](./search-ui-react.rangeinputcssclasses.inputcontainer.md) | string | (Optional) | -| [inputPrefix\_\_\_disabled?](./search-ui-react.rangeinputcssclasses.inputprefix___disabled.md) | string | (Optional) | -| [inputPrefix\_\_\_enabled?](./search-ui-react.rangeinputcssclasses.inputprefix___enabled.md) | string | (Optional) | -| [inputPrefix?](./search-ui-react.rangeinputcssclasses.inputprefix.md) | string | (Optional) | -| [inputRowContainer?](./search-ui-react.rangeinputcssclasses.inputrowcontainer.md) | string | (Optional) | -| [invalidMessage?](./search-ui-react.rangeinputcssclasses.invalidmessage.md) | string | (Optional) | -| [invalidRowContainer?](./search-ui-react.rangeinputcssclasses.invalidrowcontainer.md) | string | (Optional) | -| [rangeInputContainer?](./search-ui-react.rangeinputcssclasses.rangeinputcontainer.md) | string | (Optional) | -| [tooltip?](./search-ui-react.rangeinputcssclasses.tooltip.md) | string | (Optional) | -| [tooltipContainer?](./search-ui-react.rangeinputcssclasses.tooltipcontainer.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [applyButton?](./search-ui-react.rangeinputcssclasses.applybutton.md) | | string | _(Optional)_ | +| [buttonsContainer?](./search-ui-react.rangeinputcssclasses.buttonscontainer.md) | | string | _(Optional)_ | +| [clearButton?](./search-ui-react.rangeinputcssclasses.clearbutton.md) | | string | _(Optional)_ | +| [input\_\_\_disabled?](./search-ui-react.rangeinputcssclasses.input___disabled.md) | | string | _(Optional)_ | +| [input\_\_\_enabled?](./search-ui-react.rangeinputcssclasses.input___enabled.md) | | string | _(Optional)_ | +| [input\_\_\_invalid?](./search-ui-react.rangeinputcssclasses.input___invalid.md) | | string | _(Optional)_ | +| [input\_\_\_valid?](./search-ui-react.rangeinputcssclasses.input___valid.md) | | string | _(Optional)_ | +| [input\_\_\_withoutPrefix?](./search-ui-react.rangeinputcssclasses.input___withoutprefix.md) | | string | _(Optional)_ | +| [input\_\_\_withPrefix?](./search-ui-react.rangeinputcssclasses.input___withprefix.md) | | string | _(Optional)_ | +| [input?](./search-ui-react.rangeinputcssclasses.input.md) | | string | _(Optional)_ | +| [inputContainer?](./search-ui-react.rangeinputcssclasses.inputcontainer.md) | | string | _(Optional)_ | +| [inputPrefix\_\_\_disabled?](./search-ui-react.rangeinputcssclasses.inputprefix___disabled.md) | | string | _(Optional)_ | +| [inputPrefix\_\_\_enabled?](./search-ui-react.rangeinputcssclasses.inputprefix___enabled.md) | | string | _(Optional)_ | +| [inputPrefix?](./search-ui-react.rangeinputcssclasses.inputprefix.md) | | string | _(Optional)_ | +| [inputRowContainer?](./search-ui-react.rangeinputcssclasses.inputrowcontainer.md) | | string | _(Optional)_ | +| [invalidMessage?](./search-ui-react.rangeinputcssclasses.invalidmessage.md) | | string | _(Optional)_ | +| [invalidRowContainer?](./search-ui-react.rangeinputcssclasses.invalidrowcontainer.md) | | string | _(Optional)_ | +| [rangeInputContainer?](./search-ui-react.rangeinputcssclasses.rangeinputcontainer.md) | | string | _(Optional)_ | +| [tooltip?](./search-ui-react.rangeinputcssclasses.tooltip.md) | | string | _(Optional)_ | +| [tooltipContainer?](./search-ui-react.rangeinputcssclasses.tooltipcontainer.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.rangeinputcssclasses.rangeinputcontainer.md b/docs/search-ui-react.rangeinputcssclasses.rangeinputcontainer.md index 041a99d54..2ba368aed 100644 --- a/docs/search-ui-react.rangeinputcssclasses.rangeinputcontainer.md +++ b/docs/search-ui-react.rangeinputcssclasses.rangeinputcontainer.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.rangeInputContainer property -Signature: +**Signature:** ```typescript rangeInputContainer?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.tooltip.md b/docs/search-ui-react.rangeinputcssclasses.tooltip.md index 3989f53e3..581999661 100644 --- a/docs/search-ui-react.rangeinputcssclasses.tooltip.md +++ b/docs/search-ui-react.rangeinputcssclasses.tooltip.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.tooltip property -Signature: +**Signature:** ```typescript tooltip?: string; diff --git a/docs/search-ui-react.rangeinputcssclasses.tooltipcontainer.md b/docs/search-ui-react.rangeinputcssclasses.tooltipcontainer.md index ffd6a8ad5..6ddc9f9be 100644 --- a/docs/search-ui-react.rangeinputcssclasses.tooltipcontainer.md +++ b/docs/search-ui-react.rangeinputcssclasses.tooltipcontainer.md @@ -4,7 +4,7 @@ ## RangeInputCssClasses.tooltipContainer property -Signature: +**Signature:** ```typescript tooltipContainer?: string; diff --git a/docs/search-ui-react.renderentitypreviews.md b/docs/search-ui-react.renderentitypreviews.md index c56a0b97a..db1339a8a 100644 --- a/docs/search-ui-react.renderentitypreviews.md +++ b/docs/search-ui-react.renderentitypreviews.md @@ -6,7 +6,7 @@ The type of a functional React component which renders entity previews using a map of vertical key to the corresponding VerticalResults data. -Signature: +**Signature:** ```typescript type RenderEntityPreviews = (autocompleteLoading: boolean, verticalKeyToResults: Record, dropdownItemProps: { @@ -14,6 +14,7 @@ type RenderEntityPreviews = (autocompleteLoading: boolean, verticalKeyToResults: ariaLabel: (value: string) => string; }) => JSX.Element | null; ``` +**References:** [FocusedItemData](./search-ui-react.focuseditemdata.md) ## Remarks diff --git a/docs/search-ui-react.renderhighlightedvalue.md b/docs/search-ui-react.renderhighlightedvalue.md index f7d388a34..7da19eb94 100644 --- a/docs/search-ui-react.renderhighlightedvalue.md +++ b/docs/search-ui-react.renderhighlightedvalue.md @@ -6,7 +6,7 @@ Renders a HighlightedValue with highlighting based on its matchedSubstrings. -Signature: +**Signature:** ```typescript declare function renderHighlightedValue(highlightedValueOrString: Partial | string, customCssClasses?: HighlightedValueCssClasses): JSX.Element; @@ -17,9 +17,9 @@ declare function renderHighlightedValue(highlightedValueOrString: PartialReturns: +**Returns:** JSX.Element diff --git a/docs/search-ui-react.resultscount.md b/docs/search-ui-react.resultscount.md index 7f79b6276..47b7e99f9 100644 --- a/docs/search-ui-react.resultscount.md +++ b/docs/search-ui-react.resultscount.md @@ -6,7 +6,7 @@ Renders results count of a universal/vertical search. -Signature: +**Signature:** ```typescript declare function ResultsCount({ customCssClasses }: ResultsCountProps): JSX.Element | null; @@ -16,9 +16,9 @@ declare function ResultsCount({ customCssClasses }: ResultsCountProps): JSX.Elem | Parameter | Type | Description | | --- | --- | --- | -| { customCssClasses } | ResultsCountProps | | +| { customCssClasses } | [ResultsCountProps](./search-ui-react.resultscountprops.md) | | -Returns: +**Returns:** JSX.Element \| null diff --git a/docs/search-ui-react.resultscountcssclasses.md b/docs/search-ui-react.resultscountcssclasses.md index 416b8ec1e..046b6587e 100644 --- a/docs/search-ui-react.resultscountcssclasses.md +++ b/docs/search-ui-react.resultscountcssclasses.md @@ -6,7 +6,7 @@ The CSS class interface for [ResultsCount()](./search-ui-react.resultscount.md). -Signature: +**Signature:** ```typescript interface ResultsCountCssClasses @@ -14,8 +14,8 @@ interface ResultsCountCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [resultsCountContainer?](./search-ui-react.resultscountcssclasses.resultscountcontainer.md) | string | (Optional) | -| [resultsCountLoading?](./search-ui-react.resultscountcssclasses.resultscountloading.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [resultsCountContainer?](./search-ui-react.resultscountcssclasses.resultscountcontainer.md) | | string | _(Optional)_ | +| [resultsCountLoading?](./search-ui-react.resultscountcssclasses.resultscountloading.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.resultscountcssclasses.resultscountcontainer.md b/docs/search-ui-react.resultscountcssclasses.resultscountcontainer.md index 8a6904843..9005ec970 100644 --- a/docs/search-ui-react.resultscountcssclasses.resultscountcontainer.md +++ b/docs/search-ui-react.resultscountcssclasses.resultscountcontainer.md @@ -4,7 +4,7 @@ ## ResultsCountCssClasses.resultsCountContainer property -Signature: +**Signature:** ```typescript resultsCountContainer?: string; diff --git a/docs/search-ui-react.resultscountcssclasses.resultscountloading.md b/docs/search-ui-react.resultscountcssclasses.resultscountloading.md index af7babdaa..5fb232222 100644 --- a/docs/search-ui-react.resultscountcssclasses.resultscountloading.md +++ b/docs/search-ui-react.resultscountcssclasses.resultscountloading.md @@ -4,7 +4,7 @@ ## ResultsCountCssClasses.resultsCountLoading property -Signature: +**Signature:** ```typescript resultsCountLoading?: string; diff --git a/docs/search-ui-react.resultscountprops.customcssclasses.md b/docs/search-ui-react.resultscountprops.customcssclasses.md index cff4a5788..6608cd4c2 100644 --- a/docs/search-ui-react.resultscountprops.customcssclasses.md +++ b/docs/search-ui-react.resultscountprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: ResultsCountCssClasses; diff --git a/docs/search-ui-react.resultscountprops.md b/docs/search-ui-react.resultscountprops.md index 44eeac794..2af5dc2df 100644 --- a/docs/search-ui-react.resultscountprops.md +++ b/docs/search-ui-react.resultscountprops.md @@ -6,7 +6,7 @@ Props for [ResultsCount()](./search-ui-react.resultscount.md). -Signature: +**Signature:** ```typescript interface ResultsCountProps @@ -14,7 +14,7 @@ interface ResultsCountProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.resultscountprops.customcssclasses.md) | ResultsCountCssClasses | (Optional) CSS classes for customizing the component styling. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.resultscountprops.customcssclasses.md) | | [ResultsCountCssClasses](./search-ui-react.resultscountcssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | diff --git a/docs/search-ui-react.searchbar.md b/docs/search-ui-react.searchbar.md index fefdf9f22..ed195e3a8 100644 --- a/docs/search-ui-react.searchbar.md +++ b/docs/search-ui-react.searchbar.md @@ -6,7 +6,7 @@ Renders a SearchBar that is hooked up with an InputDropdown component. -Signature: +**Signature:** ```typescript declare function SearchBar({ placeholder, geolocationOptions, hideRecentSearches, visualAutocompleteConfig, showVerticalLinks, onSelectVerticalLink, verticalKeyToLabel, recentSearchesLimit, customCssClasses, onSearch }: SearchBarProps): JSX.Element; @@ -16,9 +16,9 @@ declare function SearchBar({ placeholder, geolocationOptions, hideRecentSearches | Parameter | Type | Description | | --- | --- | --- | -| { placeholder, geolocationOptions, hideRecentSearches, visualAutocompleteConfig, showVerticalLinks, onSelectVerticalLink, verticalKeyToLabel, recentSearchesLimit, customCssClasses, onSearch } | SearchBarProps | | +| { placeholder, geolocationOptions, hideRecentSearches, visualAutocompleteConfig, showVerticalLinks, onSelectVerticalLink, verticalKeyToLabel, recentSearchesLimit, customCssClasses, onSearch } | [SearchBarProps](./search-ui-react.searchbarprops.md) | | -Returns: +**Returns:** JSX.Element diff --git a/docs/search-ui-react.searchbarcssclasses.clearbutton.md b/docs/search-ui-react.searchbarcssclasses.clearbutton.md index 6bb3b8155..25a086b8a 100644 --- a/docs/search-ui-react.searchbarcssclasses.clearbutton.md +++ b/docs/search-ui-react.searchbarcssclasses.clearbutton.md @@ -4,7 +4,7 @@ ## SearchBarCssClasses.clearButton property -Signature: +**Signature:** ```typescript clearButton?: string; diff --git a/docs/search-ui-react.searchbarcssclasses.entitypreviewsdivider.md b/docs/search-ui-react.searchbarcssclasses.entitypreviewsdivider.md index 5470e4b6c..ec762b159 100644 --- a/docs/search-ui-react.searchbarcssclasses.entitypreviewsdivider.md +++ b/docs/search-ui-react.searchbarcssclasses.entitypreviewsdivider.md @@ -4,7 +4,7 @@ ## SearchBarCssClasses.entityPreviewsDivider property -Signature: +**Signature:** ```typescript entityPreviewsDivider?: string; diff --git a/docs/search-ui-react.searchbarcssclasses.focusedoption.md b/docs/search-ui-react.searchbarcssclasses.focusedoption.md index 72aab7868..a9e4db8d0 100644 --- a/docs/search-ui-react.searchbarcssclasses.focusedoption.md +++ b/docs/search-ui-react.searchbarcssclasses.focusedoption.md @@ -4,7 +4,7 @@ ## SearchBarCssClasses.focusedOption property -Signature: +**Signature:** ```typescript focusedOption?: string; diff --git a/docs/search-ui-react.searchbarcssclasses.inputdivider.md b/docs/search-ui-react.searchbarcssclasses.inputdivider.md index 716faca49..728def731 100644 --- a/docs/search-ui-react.searchbarcssclasses.inputdivider.md +++ b/docs/search-ui-react.searchbarcssclasses.inputdivider.md @@ -4,7 +4,7 @@ ## SearchBarCssClasses.inputDivider property -Signature: +**Signature:** ```typescript inputDivider?: string; diff --git a/docs/search-ui-react.searchbarcssclasses.inputelement.md b/docs/search-ui-react.searchbarcssclasses.inputelement.md index 8874c14aa..f38efad97 100644 --- a/docs/search-ui-react.searchbarcssclasses.inputelement.md +++ b/docs/search-ui-react.searchbarcssclasses.inputelement.md @@ -4,7 +4,7 @@ ## SearchBarCssClasses.inputElement property -Signature: +**Signature:** ```typescript inputElement?: string; diff --git a/docs/search-ui-react.searchbarcssclasses.md b/docs/search-ui-react.searchbarcssclasses.md index b8200559a..7b40812e6 100644 --- a/docs/search-ui-react.searchbarcssclasses.md +++ b/docs/search-ui-react.searchbarcssclasses.md @@ -6,28 +6,28 @@ The CSS class interface for the [SearchBar()](./search-ui-react.searchbar.md). -Signature: +**Signature:** ```typescript interface SearchBarCssClasses extends AutocompleteResultCssClasses ``` -Extends: AutocompleteResultCssClasses +**Extends:** [AutocompleteResultCssClasses](./search-ui-react.autocompleteresultcssclasses.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [clearButton?](./search-ui-react.searchbarcssclasses.clearbutton.md) | string | (Optional) | -| [entityPreviewsDivider?](./search-ui-react.searchbarcssclasses.entitypreviewsdivider.md) | string | (Optional) | -| [focusedOption?](./search-ui-react.searchbarcssclasses.focusedoption.md) | string | (Optional) | -| [inputDivider?](./search-ui-react.searchbarcssclasses.inputdivider.md) | string | (Optional) | -| [inputElement?](./search-ui-react.searchbarcssclasses.inputelement.md) | string | (Optional) | -| [recentSearchesIcon?](./search-ui-react.searchbarcssclasses.recentsearchesicon.md) | string | (Optional) | -| [recentSearchesNonHighlighted?](./search-ui-react.searchbarcssclasses.recentsearchesnonhighlighted.md) | string | (Optional) | -| [recentSearchesOption?](./search-ui-react.searchbarcssclasses.recentsearchesoption.md) | string | (Optional) | -| [searchBarContainer?](./search-ui-react.searchbarcssclasses.searchbarcontainer.md) | string | (Optional) | -| [searchButton?](./search-ui-react.searchbarcssclasses.searchbutton.md) | string | (Optional) | -| [searchButtonContainer?](./search-ui-react.searchbarcssclasses.searchbuttoncontainer.md) | string | (Optional) | -| [verticalDivider?](./search-ui-react.searchbarcssclasses.verticaldivider.md) | string | (Optional) | -| [verticalLink?](./search-ui-react.searchbarcssclasses.verticallink.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [clearButton?](./search-ui-react.searchbarcssclasses.clearbutton.md) | | string | _(Optional)_ | +| [entityPreviewsDivider?](./search-ui-react.searchbarcssclasses.entitypreviewsdivider.md) | | string | _(Optional)_ | +| [focusedOption?](./search-ui-react.searchbarcssclasses.focusedoption.md) | | string | _(Optional)_ | +| [inputDivider?](./search-ui-react.searchbarcssclasses.inputdivider.md) | | string | _(Optional)_ | +| [inputElement?](./search-ui-react.searchbarcssclasses.inputelement.md) | | string | _(Optional)_ | +| [recentSearchesIcon?](./search-ui-react.searchbarcssclasses.recentsearchesicon.md) | | string | _(Optional)_ | +| [recentSearchesNonHighlighted?](./search-ui-react.searchbarcssclasses.recentsearchesnonhighlighted.md) | | string | _(Optional)_ | +| [recentSearchesOption?](./search-ui-react.searchbarcssclasses.recentsearchesoption.md) | | string | _(Optional)_ | +| [searchBarContainer?](./search-ui-react.searchbarcssclasses.searchbarcontainer.md) | | string | _(Optional)_ | +| [searchButton?](./search-ui-react.searchbarcssclasses.searchbutton.md) | | string | _(Optional)_ | +| [searchButtonContainer?](./search-ui-react.searchbarcssclasses.searchbuttoncontainer.md) | | string | _(Optional)_ | +| [verticalDivider?](./search-ui-react.searchbarcssclasses.verticaldivider.md) | | string | _(Optional)_ | +| [verticalLink?](./search-ui-react.searchbarcssclasses.verticallink.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.searchbarcssclasses.recentsearchesicon.md b/docs/search-ui-react.searchbarcssclasses.recentsearchesicon.md index 526c0655f..160b22930 100644 --- a/docs/search-ui-react.searchbarcssclasses.recentsearchesicon.md +++ b/docs/search-ui-react.searchbarcssclasses.recentsearchesicon.md @@ -4,7 +4,7 @@ ## SearchBarCssClasses.recentSearchesIcon property -Signature: +**Signature:** ```typescript recentSearchesIcon?: string; diff --git a/docs/search-ui-react.searchbarcssclasses.recentsearchesnonhighlighted.md b/docs/search-ui-react.searchbarcssclasses.recentsearchesnonhighlighted.md index 44c3f69c5..63e454cf7 100644 --- a/docs/search-ui-react.searchbarcssclasses.recentsearchesnonhighlighted.md +++ b/docs/search-ui-react.searchbarcssclasses.recentsearchesnonhighlighted.md @@ -4,7 +4,7 @@ ## SearchBarCssClasses.recentSearchesNonHighlighted property -Signature: +**Signature:** ```typescript recentSearchesNonHighlighted?: string; diff --git a/docs/search-ui-react.searchbarcssclasses.recentsearchesoption.md b/docs/search-ui-react.searchbarcssclasses.recentsearchesoption.md index e717b1a7c..45ab17fe6 100644 --- a/docs/search-ui-react.searchbarcssclasses.recentsearchesoption.md +++ b/docs/search-ui-react.searchbarcssclasses.recentsearchesoption.md @@ -4,7 +4,7 @@ ## SearchBarCssClasses.recentSearchesOption property -Signature: +**Signature:** ```typescript recentSearchesOption?: string; diff --git a/docs/search-ui-react.searchbarcssclasses.searchbarcontainer.md b/docs/search-ui-react.searchbarcssclasses.searchbarcontainer.md index f9699e233..60677a94b 100644 --- a/docs/search-ui-react.searchbarcssclasses.searchbarcontainer.md +++ b/docs/search-ui-react.searchbarcssclasses.searchbarcontainer.md @@ -4,7 +4,7 @@ ## SearchBarCssClasses.searchBarContainer property -Signature: +**Signature:** ```typescript searchBarContainer?: string; diff --git a/docs/search-ui-react.searchbarcssclasses.searchbutton.md b/docs/search-ui-react.searchbarcssclasses.searchbutton.md index baedac395..c70f63fa9 100644 --- a/docs/search-ui-react.searchbarcssclasses.searchbutton.md +++ b/docs/search-ui-react.searchbarcssclasses.searchbutton.md @@ -4,7 +4,7 @@ ## SearchBarCssClasses.searchButton property -Signature: +**Signature:** ```typescript searchButton?: string; diff --git a/docs/search-ui-react.searchbarcssclasses.searchbuttoncontainer.md b/docs/search-ui-react.searchbarcssclasses.searchbuttoncontainer.md index 8dcb90582..35ca575ca 100644 --- a/docs/search-ui-react.searchbarcssclasses.searchbuttoncontainer.md +++ b/docs/search-ui-react.searchbarcssclasses.searchbuttoncontainer.md @@ -4,7 +4,7 @@ ## SearchBarCssClasses.searchButtonContainer property -Signature: +**Signature:** ```typescript searchButtonContainer?: string; diff --git a/docs/search-ui-react.searchbarcssclasses.verticaldivider.md b/docs/search-ui-react.searchbarcssclasses.verticaldivider.md index 184908673..906e974a9 100644 --- a/docs/search-ui-react.searchbarcssclasses.verticaldivider.md +++ b/docs/search-ui-react.searchbarcssclasses.verticaldivider.md @@ -4,7 +4,7 @@ ## SearchBarCssClasses.verticalDivider property -Signature: +**Signature:** ```typescript verticalDivider?: string; diff --git a/docs/search-ui-react.searchbarcssclasses.verticallink.md b/docs/search-ui-react.searchbarcssclasses.verticallink.md index 4ff43f282..a71f05a3e 100644 --- a/docs/search-ui-react.searchbarcssclasses.verticallink.md +++ b/docs/search-ui-react.searchbarcssclasses.verticallink.md @@ -4,7 +4,7 @@ ## SearchBarCssClasses.verticalLink property -Signature: +**Signature:** ```typescript verticalLink?: string; diff --git a/docs/search-ui-react.searchbarprops.customcssclasses.md b/docs/search-ui-react.searchbarprops.customcssclasses.md index a657879bb..b62cc987f 100644 --- a/docs/search-ui-react.searchbarprops.customcssclasses.md +++ b/docs/search-ui-react.searchbarprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: SearchBarCssClasses; diff --git a/docs/search-ui-react.searchbarprops.geolocationoptions.md b/docs/search-ui-react.searchbarprops.geolocationoptions.md index 792456f94..75d3c49db 100644 --- a/docs/search-ui-react.searchbarprops.geolocationoptions.md +++ b/docs/search-ui-react.searchbarprops.geolocationoptions.md @@ -6,7 +6,7 @@ Configuration used when collecting the user's location. Definition: [https://w3c.github.io/geolocation-api/\#position\_options\_interface](https://w3c.github.io/geolocation-api/#position_options_interface). -Signature: +**Signature:** ```typescript geolocationOptions?: PositionOptions; diff --git a/docs/search-ui-react.searchbarprops.hiderecentsearches.md b/docs/search-ui-react.searchbarprops.hiderecentsearches.md index faabc45e2..cfdab48af 100644 --- a/docs/search-ui-react.searchbarprops.hiderecentsearches.md +++ b/docs/search-ui-react.searchbarprops.hiderecentsearches.md @@ -6,7 +6,7 @@ Hides recent searches if true. -Signature: +**Signature:** ```typescript hideRecentSearches?: boolean; diff --git a/docs/search-ui-react.searchbarprops.md b/docs/search-ui-react.searchbarprops.md index 458457114..2c2e24c1f 100644 --- a/docs/search-ui-react.searchbarprops.md +++ b/docs/search-ui-react.searchbarprops.md @@ -6,7 +6,7 @@ The props for the [SearchBar()](./search-ui-react.searchbar.md) component. -Signature: +**Signature:** ```typescript interface SearchBarProps @@ -14,16 +14,16 @@ interface SearchBarProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.searchbarprops.customcssclasses.md) | SearchBarCssClasses | (Optional) CSS classes for customizing the component styling. | -| [geolocationOptions?](./search-ui-react.searchbarprops.geolocationoptions.md) | PositionOptions | (Optional) Configuration used when collecting the user's location. Definition: [https://w3c.github.io/geolocation-api/\#position\_options\_interface](https://w3c.github.io/geolocation-api/#position_options_interface). | -| [hideRecentSearches?](./search-ui-react.searchbarprops.hiderecentsearches.md) | boolean | (Optional) Hides recent searches if true. | -| [onSearch?](./search-ui-react.searchbarprops.onsearch.md) | onSearchFunc | (Optional) A callback which is called when a search is ran. | -| [onSelectVerticalLink?](./search-ui-react.searchbarprops.onselectverticallink.md) | (data: { verticalLink: VerticalLink; querySource: QuerySource; }) => void | (Optional) A function which is called when a vertical link is selected. | -| [placeholder?](./search-ui-react.searchbarprops.placeholder.md) | string | (Optional) The search bar's placeholder text. | -| [recentSearchesLimit?](./search-ui-react.searchbarprops.recentsearcheslimit.md) | number | (Optional) Limits the number of recent searches shown. | -| [showVerticalLinks?](./search-ui-react.searchbarprops.showverticallinks.md) | boolean | (Optional) Shows vertical links if true, set to false on default. | -| [verticalKeyToLabel?](./search-ui-react.searchbarprops.verticalkeytolabel.md) | (verticalKey: string) => string | (Optional) A function which returns a display label for the given verticalKey. | -| [visualAutocompleteConfig?](./search-ui-react.searchbarprops.visualautocompleteconfig.md) | VisualAutocompleteConfig | (Optional) The configuration options for Visual Autocomplete. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.searchbarprops.customcssclasses.md) | | [SearchBarCssClasses](./search-ui-react.searchbarcssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [geolocationOptions?](./search-ui-react.searchbarprops.geolocationoptions.md) | | PositionOptions | _(Optional)_ Configuration used when collecting the user's location. Definition: [https://w3c.github.io/geolocation-api/\#position\_options\_interface](https://w3c.github.io/geolocation-api/#position_options_interface). | +| [hideRecentSearches?](./search-ui-react.searchbarprops.hiderecentsearches.md) | | boolean | _(Optional)_ Hides recent searches if true. | +| [onSearch?](./search-ui-react.searchbarprops.onsearch.md) | | [onSearchFunc](./search-ui-react.onsearchfunc.md) | _(Optional)_ A callback which is called when a search is ran. | +| [onSelectVerticalLink?](./search-ui-react.searchbarprops.onselectverticallink.md) | | (data: { verticalLink: [VerticalLink](./search-ui-react.verticallink.md); querySource: QuerySource; }) => void | _(Optional)_ A function which is called when a vertical link is selected. | +| [placeholder?](./search-ui-react.searchbarprops.placeholder.md) | | string | _(Optional)_ The search bar's placeholder text. | +| [recentSearchesLimit?](./search-ui-react.searchbarprops.recentsearcheslimit.md) | | number | _(Optional)_ Limits the number of recent searches shown. | +| [showVerticalLinks?](./search-ui-react.searchbarprops.showverticallinks.md) | | boolean | _(Optional)_ Shows vertical links if true, set to false on default. | +| [verticalKeyToLabel?](./search-ui-react.searchbarprops.verticalkeytolabel.md) | | (verticalKey: string) => string | _(Optional)_ A function which returns a display label for the given verticalKey. | +| [visualAutocompleteConfig?](./search-ui-react.searchbarprops.visualautocompleteconfig.md) | | [VisualAutocompleteConfig](./search-ui-react.visualautocompleteconfig.md) | _(Optional)_ The configuration options for Visual Autocomplete. | diff --git a/docs/search-ui-react.searchbarprops.onsearch.md b/docs/search-ui-react.searchbarprops.onsearch.md index bb9b78fd2..51bed68ee 100644 --- a/docs/search-ui-react.searchbarprops.onsearch.md +++ b/docs/search-ui-react.searchbarprops.onsearch.md @@ -6,7 +6,7 @@ A callback which is called when a search is ran. -Signature: +**Signature:** ```typescript onSearch?: onSearchFunc; diff --git a/docs/search-ui-react.searchbarprops.onselectverticallink.md b/docs/search-ui-react.searchbarprops.onselectverticallink.md index 8c034ca4a..1b987076a 100644 --- a/docs/search-ui-react.searchbarprops.onselectverticallink.md +++ b/docs/search-ui-react.searchbarprops.onselectverticallink.md @@ -6,7 +6,7 @@ A function which is called when a vertical link is selected. -Signature: +**Signature:** ```typescript onSelectVerticalLink?: (data: { diff --git a/docs/search-ui-react.searchbarprops.placeholder.md b/docs/search-ui-react.searchbarprops.placeholder.md index 1c105852a..48b4d897b 100644 --- a/docs/search-ui-react.searchbarprops.placeholder.md +++ b/docs/search-ui-react.searchbarprops.placeholder.md @@ -6,7 +6,7 @@ The search bar's placeholder text. -Signature: +**Signature:** ```typescript placeholder?: string; diff --git a/docs/search-ui-react.searchbarprops.recentsearcheslimit.md b/docs/search-ui-react.searchbarprops.recentsearcheslimit.md index 6526162a2..16aadc819 100644 --- a/docs/search-ui-react.searchbarprops.recentsearcheslimit.md +++ b/docs/search-ui-react.searchbarprops.recentsearcheslimit.md @@ -6,7 +6,7 @@ Limits the number of recent searches shown. -Signature: +**Signature:** ```typescript recentSearchesLimit?: number; diff --git a/docs/search-ui-react.searchbarprops.showverticallinks.md b/docs/search-ui-react.searchbarprops.showverticallinks.md index bbc1351ed..9654d619c 100644 --- a/docs/search-ui-react.searchbarprops.showverticallinks.md +++ b/docs/search-ui-react.searchbarprops.showverticallinks.md @@ -6,7 +6,7 @@ Shows vertical links if true, set to false on default. -Signature: +**Signature:** ```typescript showVerticalLinks?: boolean; diff --git a/docs/search-ui-react.searchbarprops.verticalkeytolabel.md b/docs/search-ui-react.searchbarprops.verticalkeytolabel.md index 9eb30ea81..9250c081d 100644 --- a/docs/search-ui-react.searchbarprops.verticalkeytolabel.md +++ b/docs/search-ui-react.searchbarprops.verticalkeytolabel.md @@ -6,7 +6,7 @@ A function which returns a display label for the given verticalKey. -Signature: +**Signature:** ```typescript verticalKeyToLabel?: (verticalKey: string) => string; diff --git a/docs/search-ui-react.searchbarprops.visualautocompleteconfig.md b/docs/search-ui-react.searchbarprops.visualautocompleteconfig.md index 13d73fbe8..ab8f89431 100644 --- a/docs/search-ui-react.searchbarprops.visualautocompleteconfig.md +++ b/docs/search-ui-react.searchbarprops.visualautocompleteconfig.md @@ -6,7 +6,7 @@ The configuration options for Visual Autocomplete. -Signature: +**Signature:** ```typescript visualAutocompleteConfig?: VisualAutocompleteConfig; diff --git a/docs/search-ui-react.sectioncomponent.md b/docs/search-ui-react.sectioncomponent.md index 93803cea1..b5c05c0e2 100644 --- a/docs/search-ui-react.sectioncomponent.md +++ b/docs/search-ui-react.sectioncomponent.md @@ -6,8 +6,10 @@ A component that can be used to render a section template for vertical results. -Signature: +**Signature:** ```typescript type SectionComponent = (props: SectionProps) => JSX.Element | null; ``` +**References:** [DefaultRawDataType](./search-ui-react.defaultrawdatatype.md), [SectionProps](./search-ui-react.sectionprops.md) + diff --git a/docs/search-ui-react.sectionheadercssclasses.md b/docs/search-ui-react.sectionheadercssclasses.md index cbb375355..96b1e3007 100644 --- a/docs/search-ui-react.sectionheadercssclasses.md +++ b/docs/search-ui-react.sectionheadercssclasses.md @@ -6,20 +6,20 @@ The CSS class interface used for the SectionHeader component. -Signature: +**Signature:** ```typescript interface SectionHeaderCssClasses extends AppliedFiltersCssClasses ``` -Extends: AppliedFiltersCssClasses +**Extends:** [AppliedFiltersCssClasses](./search-ui-react.appliedfilterscssclasses.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [sectionHeaderContainer?](./search-ui-react.sectionheadercssclasses.sectionheadercontainer.md) | string | (Optional) | -| [sectionHeaderIconContainer?](./search-ui-react.sectionheadercssclasses.sectionheadericoncontainer.md) | string | (Optional) | -| [sectionHeaderLabel?](./search-ui-react.sectionheadercssclasses.sectionheaderlabel.md) | string | (Optional) | -| [viewMoreContainer?](./search-ui-react.sectionheadercssclasses.viewmorecontainer.md) | string | (Optional) | -| [viewMoreLink?](./search-ui-react.sectionheadercssclasses.viewmorelink.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [sectionHeaderContainer?](./search-ui-react.sectionheadercssclasses.sectionheadercontainer.md) | | string | _(Optional)_ | +| [sectionHeaderIconContainer?](./search-ui-react.sectionheadercssclasses.sectionheadericoncontainer.md) | | string | _(Optional)_ | +| [sectionHeaderLabel?](./search-ui-react.sectionheadercssclasses.sectionheaderlabel.md) | | string | _(Optional)_ | +| [viewMoreContainer?](./search-ui-react.sectionheadercssclasses.viewmorecontainer.md) | | string | _(Optional)_ | +| [viewMoreLink?](./search-ui-react.sectionheadercssclasses.viewmorelink.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.sectionheadercssclasses.sectionheadercontainer.md b/docs/search-ui-react.sectionheadercssclasses.sectionheadercontainer.md index 57d9ab438..f4d484b9a 100644 --- a/docs/search-ui-react.sectionheadercssclasses.sectionheadercontainer.md +++ b/docs/search-ui-react.sectionheadercssclasses.sectionheadercontainer.md @@ -4,7 +4,7 @@ ## SectionHeaderCssClasses.sectionHeaderContainer property -Signature: +**Signature:** ```typescript sectionHeaderContainer?: string; diff --git a/docs/search-ui-react.sectionheadercssclasses.sectionheadericoncontainer.md b/docs/search-ui-react.sectionheadercssclasses.sectionheadericoncontainer.md index 5806235bb..72a3ce72c 100644 --- a/docs/search-ui-react.sectionheadercssclasses.sectionheadericoncontainer.md +++ b/docs/search-ui-react.sectionheadercssclasses.sectionheadericoncontainer.md @@ -4,7 +4,7 @@ ## SectionHeaderCssClasses.sectionHeaderIconContainer property -Signature: +**Signature:** ```typescript sectionHeaderIconContainer?: string; diff --git a/docs/search-ui-react.sectionheadercssclasses.sectionheaderlabel.md b/docs/search-ui-react.sectionheadercssclasses.sectionheaderlabel.md index fab4b7e26..8f6409e37 100644 --- a/docs/search-ui-react.sectionheadercssclasses.sectionheaderlabel.md +++ b/docs/search-ui-react.sectionheadercssclasses.sectionheaderlabel.md @@ -4,7 +4,7 @@ ## SectionHeaderCssClasses.sectionHeaderLabel property -Signature: +**Signature:** ```typescript sectionHeaderLabel?: string; diff --git a/docs/search-ui-react.sectionheadercssclasses.viewmorecontainer.md b/docs/search-ui-react.sectionheadercssclasses.viewmorecontainer.md index 6df4a80cc..58a6f6bb1 100644 --- a/docs/search-ui-react.sectionheadercssclasses.viewmorecontainer.md +++ b/docs/search-ui-react.sectionheadercssclasses.viewmorecontainer.md @@ -4,7 +4,7 @@ ## SectionHeaderCssClasses.viewMoreContainer property -Signature: +**Signature:** ```typescript viewMoreContainer?: string; diff --git a/docs/search-ui-react.sectionheadercssclasses.viewmorelink.md b/docs/search-ui-react.sectionheadercssclasses.viewmorelink.md index 52599f11e..6f1b3fa23 100644 --- a/docs/search-ui-react.sectionheadercssclasses.viewmorelink.md +++ b/docs/search-ui-react.sectionheadercssclasses.viewmorelink.md @@ -4,7 +4,7 @@ ## SectionHeaderCssClasses.viewMoreLink property -Signature: +**Signature:** ```typescript viewMoreLink?: string; diff --git a/docs/search-ui-react.sectionprops.cardcomponent.md b/docs/search-ui-react.sectionprops.cardcomponent.md index 4b58bdf00..23ef9a6d4 100644 --- a/docs/search-ui-react.sectionprops.cardcomponent.md +++ b/docs/search-ui-react.sectionprops.cardcomponent.md @@ -6,7 +6,7 @@ The card to use for this vertical. -Signature: +**Signature:** ```typescript CardComponent?: CardComponent; diff --git a/docs/search-ui-react.sectionprops.header.md b/docs/search-ui-react.sectionprops.header.md index bd273558f..f633f78eb 100644 --- a/docs/search-ui-react.sectionprops.header.md +++ b/docs/search-ui-react.sectionprops.header.md @@ -6,7 +6,7 @@ A header to display above the results. -Signature: +**Signature:** ```typescript header?: JSX.Element; diff --git a/docs/search-ui-react.sectionprops.md b/docs/search-ui-react.sectionprops.md index a56557a2a..e5ddf2054 100644 --- a/docs/search-ui-react.sectionprops.md +++ b/docs/search-ui-react.sectionprops.md @@ -6,7 +6,7 @@ The configuration of a section template for a vertical's results on a universal page. -Signature: +**Signature:** ```typescript interface SectionProps @@ -14,11 +14,11 @@ interface SectionProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [CardComponent?](./search-ui-react.sectionprops.cardcomponent.md) | CardComponent<T> | (Optional) The card to use for this vertical. | -| [header?](./search-ui-react.sectionprops.header.md) | JSX.Element | (Optional) A header to display above the results. | -| [results](./search-ui-react.sectionprops.results.md) | Result<T>\[\] | The results from this vertical. | -| [verticalKey](./search-ui-react.sectionprops.verticalkey.md) | string | The key for the vertical. | -| [viewMore?](./search-ui-react.sectionprops.viewmore.md) | boolean | (Optional) Whether or not to allow more results to be viewed. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [CardComponent?](./search-ui-react.sectionprops.cardcomponent.md) | | [CardComponent](./search-ui-react.cardcomponent.md)<T> | _(Optional)_ The card to use for this vertical. | +| [header?](./search-ui-react.sectionprops.header.md) | | JSX.Element | _(Optional)_ A header to display above the results. | +| [results](./search-ui-react.sectionprops.results.md) | | Result<T>\[\] | The results from this vertical. | +| [verticalKey](./search-ui-react.sectionprops.verticalkey.md) | | string | The key for the vertical. | +| [viewMore?](./search-ui-react.sectionprops.viewmore.md) | | boolean | _(Optional)_ Whether or not to allow more results to be viewed. | diff --git a/docs/search-ui-react.sectionprops.results.md b/docs/search-ui-react.sectionprops.results.md index 4ba10daf3..dce5ac605 100644 --- a/docs/search-ui-react.sectionprops.results.md +++ b/docs/search-ui-react.sectionprops.results.md @@ -6,7 +6,7 @@ The results from this vertical. -Signature: +**Signature:** ```typescript results: Result[]; diff --git a/docs/search-ui-react.sectionprops.verticalkey.md b/docs/search-ui-react.sectionprops.verticalkey.md index 3a8184b36..997492ae9 100644 --- a/docs/search-ui-react.sectionprops.verticalkey.md +++ b/docs/search-ui-react.sectionprops.verticalkey.md @@ -6,7 +6,7 @@ The key for the vertical. -Signature: +**Signature:** ```typescript verticalKey: string; diff --git a/docs/search-ui-react.sectionprops.viewmore.md b/docs/search-ui-react.sectionprops.viewmore.md index 6ea105c6f..401514b64 100644 --- a/docs/search-ui-react.sectionprops.viewmore.md +++ b/docs/search-ui-react.sectionprops.viewmore.md @@ -6,7 +6,7 @@ Whether or not to allow more results to be viewed. -Signature: +**Signature:** ```typescript viewMore?: boolean; diff --git a/docs/search-ui-react.spellcheck.md b/docs/search-ui-react.spellcheck.md index bd062433f..72cab3e2f 100644 --- a/docs/search-ui-react.spellcheck.md +++ b/docs/search-ui-react.spellcheck.md @@ -6,7 +6,7 @@ Renders a suggested query if the Search API provides one. -Signature: +**Signature:** ```typescript declare function SpellCheck({ customCssClasses, onClick }: SpellCheckProps): JSX.Element | null; @@ -16,9 +16,9 @@ declare function SpellCheck({ customCssClasses, onClick }: SpellCheckProps): JSX | Parameter | Type | Description | | --- | --- | --- | -| { customCssClasses, onClick } | SpellCheckProps | | +| { customCssClasses, onClick } | [SpellCheckProps](./search-ui-react.spellcheckprops.md) | | -Returns: +**Returns:** JSX.Element \| null diff --git a/docs/search-ui-react.spellcheckcssclasses.helptext.md b/docs/search-ui-react.spellcheckcssclasses.helptext.md index 60b16924e..cd0cbb9f6 100644 --- a/docs/search-ui-react.spellcheckcssclasses.helptext.md +++ b/docs/search-ui-react.spellcheckcssclasses.helptext.md @@ -4,7 +4,7 @@ ## SpellCheckCssClasses.helpText property -Signature: +**Signature:** ```typescript helpText?: string; diff --git a/docs/search-ui-react.spellcheckcssclasses.link.md b/docs/search-ui-react.spellcheckcssclasses.link.md index dd7b854a9..053548625 100644 --- a/docs/search-ui-react.spellcheckcssclasses.link.md +++ b/docs/search-ui-react.spellcheckcssclasses.link.md @@ -4,7 +4,7 @@ ## SpellCheckCssClasses.link property -Signature: +**Signature:** ```typescript link?: string; diff --git a/docs/search-ui-react.spellcheckcssclasses.md b/docs/search-ui-react.spellcheckcssclasses.md index a44a01b77..a06236628 100644 --- a/docs/search-ui-react.spellcheckcssclasses.md +++ b/docs/search-ui-react.spellcheckcssclasses.md @@ -6,7 +6,7 @@ The CSS Class interface for SpellCheck. -Signature: +**Signature:** ```typescript interface SpellCheckCssClasses @@ -14,10 +14,10 @@ interface SpellCheckCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [helpText?](./search-ui-react.spellcheckcssclasses.helptext.md) | string | (Optional) | -| [link?](./search-ui-react.spellcheckcssclasses.link.md) | string | (Optional) | -| [spellCheckContainer?](./search-ui-react.spellcheckcssclasses.spellcheckcontainer.md) | string | (Optional) | -| [spellCheckLoading?](./search-ui-react.spellcheckcssclasses.spellcheckloading.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [helpText?](./search-ui-react.spellcheckcssclasses.helptext.md) | | string | _(Optional)_ | +| [link?](./search-ui-react.spellcheckcssclasses.link.md) | | string | _(Optional)_ | +| [spellCheckContainer?](./search-ui-react.spellcheckcssclasses.spellcheckcontainer.md) | | string | _(Optional)_ | +| [spellCheckLoading?](./search-ui-react.spellcheckcssclasses.spellcheckloading.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.spellcheckcssclasses.spellcheckcontainer.md b/docs/search-ui-react.spellcheckcssclasses.spellcheckcontainer.md index cf603bbce..4400712ee 100644 --- a/docs/search-ui-react.spellcheckcssclasses.spellcheckcontainer.md +++ b/docs/search-ui-react.spellcheckcssclasses.spellcheckcontainer.md @@ -4,7 +4,7 @@ ## SpellCheckCssClasses.spellCheckContainer property -Signature: +**Signature:** ```typescript spellCheckContainer?: string; diff --git a/docs/search-ui-react.spellcheckcssclasses.spellcheckloading.md b/docs/search-ui-react.spellcheckcssclasses.spellcheckloading.md index 4a46772d3..bac627b2e 100644 --- a/docs/search-ui-react.spellcheckcssclasses.spellcheckloading.md +++ b/docs/search-ui-react.spellcheckcssclasses.spellcheckloading.md @@ -4,7 +4,7 @@ ## SpellCheckCssClasses.spellCheckLoading property -Signature: +**Signature:** ```typescript spellCheckLoading?: string; diff --git a/docs/search-ui-react.spellcheckprops.customcssclasses.md b/docs/search-ui-react.spellcheckprops.customcssclasses.md index 2ad24232e..591234a49 100644 --- a/docs/search-ui-react.spellcheckprops.customcssclasses.md +++ b/docs/search-ui-react.spellcheckprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: SpellCheckCssClasses; diff --git a/docs/search-ui-react.spellcheckprops.md b/docs/search-ui-react.spellcheckprops.md index e8af6073f..c83fd93bd 100644 --- a/docs/search-ui-react.spellcheckprops.md +++ b/docs/search-ui-react.spellcheckprops.md @@ -6,7 +6,7 @@ The props for the [SpellCheck()](./search-ui-react.spellcheck.md) component. -Signature: +**Signature:** ```typescript interface SpellCheckProps @@ -14,8 +14,8 @@ interface SpellCheckProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.spellcheckprops.customcssclasses.md) | SpellCheckCssClasses | (Optional) CSS classes for customizing the component styling. | -| [onClick?](./search-ui-react.spellcheckprops.onclick.md) | (data: { correctedQuery: string; verticalKey: string; }) => void | (Optional) A function which is called when a spell check suggestion is clicked. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.spellcheckprops.customcssclasses.md) | | [SpellCheckCssClasses](./search-ui-react.spellcheckcssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [onClick?](./search-ui-react.spellcheckprops.onclick.md) | | (data: { correctedQuery: string; verticalKey: string; }) => void | _(Optional)_ A function which is called when a spell check suggestion is clicked. | diff --git a/docs/search-ui-react.spellcheckprops.onclick.md b/docs/search-ui-react.spellcheckprops.onclick.md index 4fea23923..7180b7a26 100644 --- a/docs/search-ui-react.spellcheckprops.onclick.md +++ b/docs/search-ui-react.spellcheckprops.onclick.md @@ -6,7 +6,7 @@ A function which is called when a spell check suggestion is clicked. -Signature: +**Signature:** ```typescript onClick?: (data: { diff --git a/docs/search-ui-react.standardcard.md b/docs/search-ui-react.standardcard.md index a40c5130c..a398f0145 100644 --- a/docs/search-ui-react.standardcard.md +++ b/docs/search-ui-react.standardcard.md @@ -6,7 +6,7 @@ This Component renders the base result card. -Signature: +**Signature:** ```typescript declare function StandardCard(props: StandardCardProps): JSX.Element; @@ -16,9 +16,9 @@ declare function StandardCard(props: StandardCardProps): JSX.Element; | Parameter | Type | Description | | --- | --- | --- | -| props | StandardCardProps<any> | An object containing the result itself and any additional information needed to render the card | +| props | [StandardCardProps](./search-ui-react.standardcardprops.md)<any> | An object containing the result itself and any additional information needed to render the card | -Returns: +**Returns:** JSX.Element diff --git a/docs/search-ui-react.standardcardcssclasses.body.md b/docs/search-ui-react.standardcardcssclasses.body.md index e7c41f6a1..11544aba5 100644 --- a/docs/search-ui-react.standardcardcssclasses.body.md +++ b/docs/search-ui-react.standardcardcssclasses.body.md @@ -4,7 +4,7 @@ ## StandardCardCssClasses.body property -Signature: +**Signature:** ```typescript body?: string; diff --git a/docs/search-ui-react.standardcardcssclasses.container.md b/docs/search-ui-react.standardcardcssclasses.container.md index 812328db9..709c3ec27 100644 --- a/docs/search-ui-react.standardcardcssclasses.container.md +++ b/docs/search-ui-react.standardcardcssclasses.container.md @@ -4,7 +4,7 @@ ## StandardCardCssClasses.container property -Signature: +**Signature:** ```typescript container?: string; diff --git a/docs/search-ui-react.standardcardcssclasses.cta1.md b/docs/search-ui-react.standardcardcssclasses.cta1.md index 3dc9b12ec..18b035a89 100644 --- a/docs/search-ui-react.standardcardcssclasses.cta1.md +++ b/docs/search-ui-react.standardcardcssclasses.cta1.md @@ -4,7 +4,7 @@ ## StandardCardCssClasses.cta1 property -Signature: +**Signature:** ```typescript cta1?: string; diff --git a/docs/search-ui-react.standardcardcssclasses.cta2.md b/docs/search-ui-react.standardcardcssclasses.cta2.md index 4a0638b3a..4ef1ab813 100644 --- a/docs/search-ui-react.standardcardcssclasses.cta2.md +++ b/docs/search-ui-react.standardcardcssclasses.cta2.md @@ -4,7 +4,7 @@ ## StandardCardCssClasses.cta2 property -Signature: +**Signature:** ```typescript cta2?: string; diff --git a/docs/search-ui-react.standardcardcssclasses.header.md b/docs/search-ui-react.standardcardcssclasses.header.md index dd99b16a1..d99c20c22 100644 --- a/docs/search-ui-react.standardcardcssclasses.header.md +++ b/docs/search-ui-react.standardcardcssclasses.header.md @@ -4,7 +4,7 @@ ## StandardCardCssClasses.header property -Signature: +**Signature:** ```typescript header?: string; diff --git a/docs/search-ui-react.standardcardcssclasses.md b/docs/search-ui-react.standardcardcssclasses.md index 35fed6d0e..fc6cb21de 100644 --- a/docs/search-ui-react.standardcardcssclasses.md +++ b/docs/search-ui-react.standardcardcssclasses.md @@ -6,21 +6,21 @@ The CSS class interface used for the StandardCardDisplay. -Signature: +**Signature:** ```typescript interface StandardCardCssClasses extends ThumbsFeedbackCssClasses ``` -Extends: ThumbsFeedbackCssClasses +**Extends:** [ThumbsFeedbackCssClasses](./search-ui-react.thumbsfeedbackcssclasses.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [body?](./search-ui-react.standardcardcssclasses.body.md) | string | (Optional) | -| [container?](./search-ui-react.standardcardcssclasses.container.md) | string | (Optional) | -| [cta1?](./search-ui-react.standardcardcssclasses.cta1.md) | string | (Optional) | -| [cta2?](./search-ui-react.standardcardcssclasses.cta2.md) | string | (Optional) | -| [header?](./search-ui-react.standardcardcssclasses.header.md) | string | (Optional) | -| [title?](./search-ui-react.standardcardcssclasses.title.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [body?](./search-ui-react.standardcardcssclasses.body.md) | | string | _(Optional)_ | +| [container?](./search-ui-react.standardcardcssclasses.container.md) | | string | _(Optional)_ | +| [cta1?](./search-ui-react.standardcardcssclasses.cta1.md) | | string | _(Optional)_ | +| [cta2?](./search-ui-react.standardcardcssclasses.cta2.md) | | string | _(Optional)_ | +| [header?](./search-ui-react.standardcardcssclasses.header.md) | | string | _(Optional)_ | +| [title?](./search-ui-react.standardcardcssclasses.title.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.standardcardcssclasses.title.md b/docs/search-ui-react.standardcardcssclasses.title.md index 9f5939697..afa8ee5a6 100644 --- a/docs/search-ui-react.standardcardcssclasses.title.md +++ b/docs/search-ui-react.standardcardcssclasses.title.md @@ -4,7 +4,7 @@ ## StandardCardCssClasses.title property -Signature: +**Signature:** ```typescript title?: string; diff --git a/docs/search-ui-react.standardcarddata.cta1.md b/docs/search-ui-react.standardcarddata.cta1.md index 93cd0b146..3c52cd93d 100644 --- a/docs/search-ui-react.standardcarddata.cta1.md +++ b/docs/search-ui-react.standardcarddata.cta1.md @@ -6,7 +6,7 @@ CTA data to render. -Signature: +**Signature:** ```typescript cta1: CtaData; diff --git a/docs/search-ui-react.standardcarddata.cta2.md b/docs/search-ui-react.standardcarddata.cta2.md index 97e875634..731b0e2f5 100644 --- a/docs/search-ui-react.standardcarddata.cta2.md +++ b/docs/search-ui-react.standardcarddata.cta2.md @@ -6,7 +6,7 @@ CTA data to render. -Signature: +**Signature:** ```typescript cta2: CtaData; diff --git a/docs/search-ui-react.standardcarddata.description.md b/docs/search-ui-react.standardcarddata.description.md index ffde4e36e..fdf6dce02 100644 --- a/docs/search-ui-react.standardcarddata.description.md +++ b/docs/search-ui-react.standardcarddata.description.md @@ -6,7 +6,7 @@ The content to display in the card's body. -Signature: +**Signature:** ```typescript description: HighlightedValue | string; diff --git a/docs/search-ui-react.standardcarddata.md b/docs/search-ui-react.standardcarddata.md index 48c777b0c..a6c380e7a 100644 --- a/docs/search-ui-react.standardcarddata.md +++ b/docs/search-ui-react.standardcarddata.md @@ -6,7 +6,7 @@ The data used by the [StandardCard()](./search-ui-react.standardcard.md) and taken from the original Result. -Signature: +**Signature:** ```typescript interface StandardCardData @@ -14,10 +14,10 @@ interface StandardCardData ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [cta1](./search-ui-react.standardcarddata.cta1.md) | CtaData | CTA data to render. | -| [cta2](./search-ui-react.standardcarddata.cta2.md) | CtaData | CTA data to render. | -| [description](./search-ui-react.standardcarddata.description.md) | HighlightedValue \| string | The content to display in the card's body. | -| [title](./search-ui-react.standardcarddata.title.md) | HighlightedValue \| string | The text to display in the card's header. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [cta1](./search-ui-react.standardcarddata.cta1.md) | | [CtaData](./search-ui-react.ctadata.md) | CTA data to render. | +| [cta2](./search-ui-react.standardcarddata.cta2.md) | | [CtaData](./search-ui-react.ctadata.md) | CTA data to render. | +| [description](./search-ui-react.standardcarddata.description.md) | | HighlightedValue \| string | The content to display in the card's body. | +| [title](./search-ui-react.standardcarddata.title.md) | | HighlightedValue \| string | The text to display in the card's header. | diff --git a/docs/search-ui-react.standardcarddata.title.md b/docs/search-ui-react.standardcarddata.title.md index 3632110ee..568e759d9 100644 --- a/docs/search-ui-react.standardcarddata.title.md +++ b/docs/search-ui-react.standardcarddata.title.md @@ -6,7 +6,7 @@ The text to display in the card's header. -Signature: +**Signature:** ```typescript title: HighlightedValue | string; diff --git a/docs/search-ui-react.standardcardprops.customcssclasses.md b/docs/search-ui-react.standardcardprops.customcssclasses.md index a486ff425..ae21998cf 100644 --- a/docs/search-ui-react.standardcardprops.customcssclasses.md +++ b/docs/search-ui-react.standardcardprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: StandardCardCssClasses; diff --git a/docs/search-ui-react.standardcardprops.md b/docs/search-ui-react.standardcardprops.md index 35b1d50c0..12b5cee3c 100644 --- a/docs/search-ui-react.standardcardprops.md +++ b/docs/search-ui-react.standardcardprops.md @@ -6,17 +6,17 @@ Props for a StandardCard. -Signature: +**Signature:** ```typescript interface StandardCardProps extends CardProps ``` -Extends: CardProps<T> +**Extends:** [CardProps](./search-ui-react.cardprops.md)<T> ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.standardcardprops.customcssclasses.md) | StandardCardCssClasses | (Optional) CSS classes for customizing the component styling. | -| [showFeedbackButtons?](./search-ui-react.standardcardprops.showfeedbackbuttons.md) | boolean | (Optional) Whether to show thumbs up/down buttons to provide feedback on the result card | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.standardcardprops.customcssclasses.md) | | [StandardCardCssClasses](./search-ui-react.standardcardcssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [showFeedbackButtons?](./search-ui-react.standardcardprops.showfeedbackbuttons.md) | | boolean | _(Optional)_ Whether to show thumbs up/down buttons to provide feedback on the result card | diff --git a/docs/search-ui-react.standardcardprops.showfeedbackbuttons.md b/docs/search-ui-react.standardcardprops.showfeedbackbuttons.md index 968d870ab..5fc29fa3d 100644 --- a/docs/search-ui-react.standardcardprops.showfeedbackbuttons.md +++ b/docs/search-ui-react.standardcardprops.showfeedbackbuttons.md @@ -6,7 +6,7 @@ Whether to show thumbs up/down buttons to provide feedback on the result card -Signature: +**Signature:** ```typescript showFeedbackButtons?: boolean; diff --git a/docs/search-ui-react.standardfacet.md b/docs/search-ui-react.standardfacet.md index b076195e9..cbecfcc01 100644 --- a/docs/search-ui-react.standardfacet.md +++ b/docs/search-ui-react.standardfacet.md @@ -6,7 +6,7 @@ A component that displays a single standard facet. Use this to override the default rendering. -Signature: +**Signature:** ```typescript declare function StandardFacet(props: StandardFacetProps): null; @@ -16,9 +16,9 @@ declare function StandardFacet(props: StandardFacetProps): null; | Parameter | Type | Description | | --- | --- | --- | -| props | StandardFacetProps | [StandardFacetProps](./search-ui-react.standardfacetprops.md) | +| props | [StandardFacetProps](./search-ui-react.standardfacetprops.md) | [StandardFacetProps](./search-ui-react.standardfacetprops.md) | -Returns: +**Returns:** null diff --git a/docs/search-ui-react.standardfacetprops.collapsible.md b/docs/search-ui-react.standardfacetprops.collapsible.md index 82508d336..7a2dc5237 100644 --- a/docs/search-ui-react.standardfacetprops.collapsible.md +++ b/docs/search-ui-react.standardfacetprops.collapsible.md @@ -6,7 +6,7 @@ Whether or not the filter is collapsible. Defaults to true. -Signature: +**Signature:** ```typescript collapsible?: boolean; diff --git a/docs/search-ui-react.standardfacetprops.customcssclasses.md b/docs/search-ui-react.standardfacetprops.customcssclasses.md index 0c8758dcd..738ba7654 100644 --- a/docs/search-ui-react.standardfacetprops.customcssclasses.md +++ b/docs/search-ui-react.standardfacetprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: FilterGroupCssClasses; diff --git a/docs/search-ui-react.standardfacetprops.defaultexpanded.md b/docs/search-ui-react.standardfacetprops.defaultexpanded.md index c8d2e25d6..9fdf2fb92 100644 --- a/docs/search-ui-react.standardfacetprops.defaultexpanded.md +++ b/docs/search-ui-react.standardfacetprops.defaultexpanded.md @@ -6,7 +6,7 @@ If the filter group is collapsible, whether or not it should start out expanded. Defaults to true. -Signature: +**Signature:** ```typescript defaultExpanded?: boolean; diff --git a/docs/search-ui-react.standardfacetprops.fieldid.md b/docs/search-ui-react.standardfacetprops.fieldid.md index 73096426d..63946ad13 100644 --- a/docs/search-ui-react.standardfacetprops.fieldid.md +++ b/docs/search-ui-react.standardfacetprops.fieldid.md @@ -6,7 +6,7 @@ The fieldId corresponding to the facet -Signature: +**Signature:** ```typescript fieldId: string; diff --git a/docs/search-ui-react.standardfacetprops.label.md b/docs/search-ui-react.standardfacetprops.label.md index a1e0c7a0f..a5654b1cc 100644 --- a/docs/search-ui-react.standardfacetprops.label.md +++ b/docs/search-ui-react.standardfacetprops.label.md @@ -6,7 +6,7 @@ The label of the facet. Defaults to facet's displayName if not provided. -Signature: +**Signature:** ```typescript label?: string; diff --git a/docs/search-ui-react.standardfacetprops.md b/docs/search-ui-react.standardfacetprops.md index 90fea9af7..296af2508 100644 --- a/docs/search-ui-react.standardfacetprops.md +++ b/docs/search-ui-react.standardfacetprops.md @@ -6,7 +6,7 @@ Props for the [StandardFacet()](./search-ui-react.standardfacet.md) component. -Signature: +**Signature:** ```typescript interface StandardFacetProps @@ -14,14 +14,14 @@ interface StandardFacetProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [collapsible?](./search-ui-react.standardfacetprops.collapsible.md) | boolean | (Optional) Whether or not the filter is collapsible. Defaults to true. | -| [customCssClasses?](./search-ui-react.standardfacetprops.customcssclasses.md) | FilterGroupCssClasses | (Optional) CSS classes for customizing the component styling. | -| [defaultExpanded?](./search-ui-react.standardfacetprops.defaultexpanded.md) | boolean | (Optional) If the filter group is collapsible, whether or not it should start out expanded. Defaults to true. | -| [fieldId](./search-ui-react.standardfacetprops.fieldid.md) | string | The fieldId corresponding to the facet | -| [label?](./search-ui-react.standardfacetprops.label.md) | string | (Optional) The label of the facet. Defaults to facet's displayName if not provided. | -| [showMoreLimit?](./search-ui-react.standardfacetprops.showmorelimit.md) | number | (Optional) The maximum number of options to render before displaying the "Show more/less" button. Defaults to 10. | -| [showOptionCounts?](./search-ui-react.standardfacetprops.showoptioncounts.md) | boolean | (Optional) Whether or not to show the option counts for each filter. Defaults to true. | -| [transformOptions?](./search-ui-react.standardfacetprops.transformoptions.md) | (options: DisplayableFacetOption\[\]) => DisplayableFacetOption\[\] | (Optional) A function to transform facet's options. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [collapsible?](./search-ui-react.standardfacetprops.collapsible.md) | | boolean | _(Optional)_ Whether or not the filter is collapsible. Defaults to true. | +| [customCssClasses?](./search-ui-react.standardfacetprops.customcssclasses.md) | | [FilterGroupCssClasses](./search-ui-react.filtergroupcssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [defaultExpanded?](./search-ui-react.standardfacetprops.defaultexpanded.md) | | boolean | _(Optional)_ If the filter group is collapsible, whether or not it should start out expanded. Defaults to true. | +| [fieldId](./search-ui-react.standardfacetprops.fieldid.md) | | string | The fieldId corresponding to the facet | +| [label?](./search-ui-react.standardfacetprops.label.md) | | string | _(Optional)_ The label of the facet. Defaults to facet's displayName if not provided. | +| [showMoreLimit?](./search-ui-react.standardfacetprops.showmorelimit.md) | | number | _(Optional)_ The maximum number of options to render before displaying the "Show more/less" button. Defaults to 10. | +| [showOptionCounts?](./search-ui-react.standardfacetprops.showoptioncounts.md) | | boolean | _(Optional)_ Whether or not to show the option counts for each filter. Defaults to true. | +| [transformOptions?](./search-ui-react.standardfacetprops.transformoptions.md) | | (options: DisplayableFacetOption\[\]) => DisplayableFacetOption\[\] | _(Optional)_ A function to transform facet's options. | diff --git a/docs/search-ui-react.standardfacetprops.showmorelimit.md b/docs/search-ui-react.standardfacetprops.showmorelimit.md index ec85f8dc1..49a182693 100644 --- a/docs/search-ui-react.standardfacetprops.showmorelimit.md +++ b/docs/search-ui-react.standardfacetprops.showmorelimit.md @@ -6,7 +6,7 @@ The maximum number of options to render before displaying the "Show more/less" button. Defaults to 10. -Signature: +**Signature:** ```typescript showMoreLimit?: number; diff --git a/docs/search-ui-react.standardfacetprops.showoptioncounts.md b/docs/search-ui-react.standardfacetprops.showoptioncounts.md index a449f9916..e993a9f6c 100644 --- a/docs/search-ui-react.standardfacetprops.showoptioncounts.md +++ b/docs/search-ui-react.standardfacetprops.showoptioncounts.md @@ -6,7 +6,7 @@ Whether or not to show the option counts for each filter. Defaults to true. -Signature: +**Signature:** ```typescript showOptionCounts?: boolean; diff --git a/docs/search-ui-react.standardfacetprops.transformoptions.md b/docs/search-ui-react.standardfacetprops.transformoptions.md index fb174ecb3..ee50dfea4 100644 --- a/docs/search-ui-react.standardfacetprops.transformoptions.md +++ b/docs/search-ui-react.standardfacetprops.transformoptions.md @@ -6,7 +6,7 @@ A function to transform facet's options. -Signature: +**Signature:** ```typescript transformOptions?: (options: DisplayableFacetOption[]) => DisplayableFacetOption[]; diff --git a/docs/search-ui-react.standardfacets.md b/docs/search-ui-react.standardfacets.md index 3b94e8e58..710d39dce 100644 --- a/docs/search-ui-react.standardfacets.md +++ b/docs/search-ui-react.standardfacets.md @@ -11,21 +11,21 @@ A component that displays simple facets applicable to the current vertical search. -Signature: +**Signature:** ```typescript -declare function StandardFacets(props: StandardFacetsProps): React.JSX.Element; +declare function StandardFacets(props: StandardFacetsProps): JSX.Element; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| props | StandardFacetsProps | [StandardFacetsProps](./search-ui-react.standardfacetsprops.md) | +| props | [StandardFacetsProps](./search-ui-react.standardfacetsprops.md) | [StandardFacetsProps](./search-ui-react.standardfacetsprops.md) | -Returns: +**Returns:** -React.JSX.Element +JSX.Element A React component for facets diff --git a/docs/search-ui-react.standardfacetscssclasses.divider.md b/docs/search-ui-react.standardfacetscssclasses.divider.md index 061b1d9c8..fa64b19f4 100644 --- a/docs/search-ui-react.standardfacetscssclasses.divider.md +++ b/docs/search-ui-react.standardfacetscssclasses.divider.md @@ -4,7 +4,7 @@ ## StandardFacetsCssClasses.divider property -Signature: +**Signature:** ```typescript divider?: string; diff --git a/docs/search-ui-react.standardfacetscssclasses.md b/docs/search-ui-react.standardfacetscssclasses.md index e69e948ab..3f730c529 100644 --- a/docs/search-ui-react.standardfacetscssclasses.md +++ b/docs/search-ui-react.standardfacetscssclasses.md @@ -11,17 +11,17 @@ The CSS class interface for [StandardFacets()](./search-ui-react.standardfacets.md). -Signature: +**Signature:** ```typescript interface StandardFacetsCssClasses extends FilterGroupCssClasses ``` -Extends: FilterGroupCssClasses +**Extends:** [FilterGroupCssClasses](./search-ui-react.filtergroupcssclasses.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [divider?](./search-ui-react.standardfacetscssclasses.divider.md) | string | (Optional) | -| [standardFacetsContainer?](./search-ui-react.standardfacetscssclasses.standardfacetscontainer.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [divider?](./search-ui-react.standardfacetscssclasses.divider.md) | | string | _(Optional)_ | +| [standardFacetsContainer?](./search-ui-react.standardfacetscssclasses.standardfacetscontainer.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.standardfacetscssclasses.standardfacetscontainer.md b/docs/search-ui-react.standardfacetscssclasses.standardfacetscontainer.md index eaeecd286..a1e659e5a 100644 --- a/docs/search-ui-react.standardfacetscssclasses.standardfacetscontainer.md +++ b/docs/search-ui-react.standardfacetscssclasses.standardfacetscontainer.md @@ -4,7 +4,7 @@ ## StandardFacetsCssClasses.standardFacetsContainer property -Signature: +**Signature:** ```typescript standardFacetsContainer?: string; diff --git a/docs/search-ui-react.standardfacetsprops.collapsible.md b/docs/search-ui-react.standardfacetsprops.collapsible.md index 318d68c7e..f17195e4f 100644 --- a/docs/search-ui-react.standardfacetsprops.collapsible.md +++ b/docs/search-ui-react.standardfacetsprops.collapsible.md @@ -6,7 +6,7 @@ Whether or not the filter is collapsible. Defaults to true. -Signature: +**Signature:** ```typescript collapsible?: boolean; diff --git a/docs/search-ui-react.standardfacetsprops.customcssclasses.md b/docs/search-ui-react.standardfacetsprops.customcssclasses.md index 381fd05db..67c52e07a 100644 --- a/docs/search-ui-react.standardfacetsprops.customcssclasses.md +++ b/docs/search-ui-react.standardfacetsprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: StandardFacetsCssClasses; diff --git a/docs/search-ui-react.standardfacetsprops.defaultexpanded.md b/docs/search-ui-react.standardfacetsprops.defaultexpanded.md index 35e5de393..070fc5822 100644 --- a/docs/search-ui-react.standardfacetsprops.defaultexpanded.md +++ b/docs/search-ui-react.standardfacetsprops.defaultexpanded.md @@ -6,7 +6,7 @@ If the filter group is collapsible, whether or not it should start out expanded. Defaults to true. -Signature: +**Signature:** ```typescript defaultExpanded?: boolean; diff --git a/docs/search-ui-react.standardfacetsprops.excludedfieldids.md b/docs/search-ui-react.standardfacetsprops.excludedfieldids.md index 99a058bc1..92ba68a8a 100644 --- a/docs/search-ui-react.standardfacetsprops.excludedfieldids.md +++ b/docs/search-ui-react.standardfacetsprops.excludedfieldids.md @@ -6,7 +6,7 @@ List of filter ids that should not be displayed. -Signature: +**Signature:** ```typescript excludedFieldIds?: string[]; diff --git a/docs/search-ui-react.standardfacetsprops.md b/docs/search-ui-react.standardfacetsprops.md index cf3982d72..b6c6692f4 100644 --- a/docs/search-ui-react.standardfacetsprops.md +++ b/docs/search-ui-react.standardfacetsprops.md @@ -11,7 +11,7 @@ Props for the [StandardFacets()](./search-ui-react.standardfacets.md) component. -Signature: +**Signature:** ```typescript interface StandardFacetsProps @@ -19,13 +19,13 @@ interface StandardFacetsProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [collapsible?](./search-ui-react.standardfacetsprops.collapsible.md) | boolean | (Optional) Whether or not the filter is collapsible. Defaults to true. | -| [customCssClasses?](./search-ui-react.standardfacetsprops.customcssclasses.md) | StandardFacetsCssClasses | (Optional) CSS classes for customizing the component styling. | -| [defaultExpanded?](./search-ui-react.standardfacetsprops.defaultexpanded.md) | boolean | (Optional) If the filter group is collapsible, whether or not it should start out expanded. Defaults to true. | -| [excludedFieldIds?](./search-ui-react.standardfacetsprops.excludedfieldids.md) | string\[\] | (Optional) List of filter ids that should not be displayed. | -| [searchOnChange?](./search-ui-react.standardfacetsprops.searchonchange.md) | boolean | (Optional) Whether or not a search is automatically run when a filter is selected. Defaults to true. | -| [showMoreLimit?](./search-ui-react.standardfacetsprops.showmorelimit.md) | number | (Optional) Limit on the number of options to be displayed. Defaults to 10. | -| [showOptionCounts?](./search-ui-react.standardfacetsprops.showoptioncounts.md) | boolean | (Optional) Whether or not to show the option counts for each filter. Defaults to true. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [collapsible?](./search-ui-react.standardfacetsprops.collapsible.md) | | boolean | _(Optional)_ Whether or not the filter is collapsible. Defaults to true. | +| [customCssClasses?](./search-ui-react.standardfacetsprops.customcssclasses.md) | | [StandardFacetsCssClasses](./search-ui-react.standardfacetscssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [defaultExpanded?](./search-ui-react.standardfacetsprops.defaultexpanded.md) | | boolean | _(Optional)_ If the filter group is collapsible, whether or not it should start out expanded. Defaults to true. | +| [excludedFieldIds?](./search-ui-react.standardfacetsprops.excludedfieldids.md) | | string\[\] | _(Optional)_ List of filter ids that should not be displayed. | +| [searchOnChange?](./search-ui-react.standardfacetsprops.searchonchange.md) | | boolean | _(Optional)_ Whether or not a search is automatically run when a filter is selected. Defaults to true. | +| [showMoreLimit?](./search-ui-react.standardfacetsprops.showmorelimit.md) | | number | _(Optional)_ Limit on the number of options to be displayed. Defaults to 10. | +| [showOptionCounts?](./search-ui-react.standardfacetsprops.showoptioncounts.md) | | boolean | _(Optional)_ Whether or not to show the option counts for each filter. Defaults to true. | diff --git a/docs/search-ui-react.standardfacetsprops.searchonchange.md b/docs/search-ui-react.standardfacetsprops.searchonchange.md index 1da216ddd..debea43c0 100644 --- a/docs/search-ui-react.standardfacetsprops.searchonchange.md +++ b/docs/search-ui-react.standardfacetsprops.searchonchange.md @@ -6,7 +6,7 @@ Whether or not a search is automatically run when a filter is selected. Defaults to true. -Signature: +**Signature:** ```typescript searchOnChange?: boolean; diff --git a/docs/search-ui-react.standardfacetsprops.showmorelimit.md b/docs/search-ui-react.standardfacetsprops.showmorelimit.md index d2686a663..10c9567d5 100644 --- a/docs/search-ui-react.standardfacetsprops.showmorelimit.md +++ b/docs/search-ui-react.standardfacetsprops.showmorelimit.md @@ -6,7 +6,7 @@ Limit on the number of options to be displayed. Defaults to 10. -Signature: +**Signature:** ```typescript showMoreLimit?: number; diff --git a/docs/search-ui-react.standardfacetsprops.showoptioncounts.md b/docs/search-ui-react.standardfacetsprops.showoptioncounts.md index 92420e0f1..ea5d269d3 100644 --- a/docs/search-ui-react.standardfacetsprops.showoptioncounts.md +++ b/docs/search-ui-react.standardfacetsprops.showoptioncounts.md @@ -6,7 +6,7 @@ Whether or not to show the option counts for each filter. Defaults to true. -Signature: +**Signature:** ```typescript showOptionCounts?: boolean; diff --git a/docs/search-ui-react.standardsection.md b/docs/search-ui-react.standardsection.md index 8acabf9ac..35b932a23 100644 --- a/docs/search-ui-react.standardsection.md +++ b/docs/search-ui-react.standardsection.md @@ -6,7 +6,7 @@ A component that displays all the results for a vertical using a standard section template. -Signature: +**Signature:** ```typescript declare function StandardSection(props: StandardSectionProps): JSX.Element | null; @@ -16,9 +16,9 @@ declare function StandardSection(props: StandardSectionProps): JSX.Element | Parameter | Type | Description | | --- | --- | --- | -| props | StandardSectionProps<T> | [StandardSectionProps](./search-ui-react.standardsectionprops.md) | +| props | [StandardSectionProps](./search-ui-react.standardsectionprops.md)<T> | [StandardSectionProps](./search-ui-react.standardsectionprops.md) | -Returns: +**Returns:** JSX.Element \| null diff --git a/docs/search-ui-react.standardsectioncssclasses.md b/docs/search-ui-react.standardsectioncssclasses.md index 6d9fc3b7a..3d5880e44 100644 --- a/docs/search-ui-react.standardsectioncssclasses.md +++ b/docs/search-ui-react.standardsectioncssclasses.md @@ -6,16 +6,16 @@ The CSS class interface used for [StandardSection()](./search-ui-react.standardsection.md). -Signature: +**Signature:** ```typescript interface StandardSectionCssClasses extends VerticalResultsCssClasses ``` -Extends: VerticalResultsCssClasses +**Extends:** [VerticalResultsCssClasses](./search-ui-react.verticalresultscssclasses.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [section?](./search-ui-react.standardsectioncssclasses.section.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [section?](./search-ui-react.standardsectioncssclasses.section.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.standardsectioncssclasses.section.md b/docs/search-ui-react.standardsectioncssclasses.section.md index e7a749850..572a322cd 100644 --- a/docs/search-ui-react.standardsectioncssclasses.section.md +++ b/docs/search-ui-react.standardsectioncssclasses.section.md @@ -4,7 +4,7 @@ ## StandardSectionCssClasses.section property -Signature: +**Signature:** ```typescript section?: string; diff --git a/docs/search-ui-react.standardsectionprops.customcssclasses.md b/docs/search-ui-react.standardsectionprops.customcssclasses.md index 6d345639d..b7a3eb02f 100644 --- a/docs/search-ui-react.standardsectionprops.customcssclasses.md +++ b/docs/search-ui-react.standardsectionprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: StandardSectionCssClasses; diff --git a/docs/search-ui-react.standardsectionprops.md b/docs/search-ui-react.standardsectionprops.md index 39f5101d7..106dcd594 100644 --- a/docs/search-ui-react.standardsectionprops.md +++ b/docs/search-ui-react.standardsectionprops.md @@ -6,16 +6,16 @@ The configuration for a StandardSection. -Signature: +**Signature:** ```typescript interface StandardSectionProps extends SectionProps ``` -Extends: SectionProps<T> +**Extends:** [SectionProps](./search-ui-react.sectionprops.md)<T> ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.standardsectionprops.customcssclasses.md) | StandardSectionCssClasses | (Optional) CSS classes for customizing the component styling. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.standardsectionprops.customcssclasses.md) | | [StandardSectionCssClasses](./search-ui-react.standardsectioncssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | diff --git a/docs/search-ui-react.staticfilteroptionconfig.md b/docs/search-ui-react.staticfilteroptionconfig.md index 725c0617d..06e2734a5 100644 --- a/docs/search-ui-react.staticfilteroptionconfig.md +++ b/docs/search-ui-react.staticfilteroptionconfig.md @@ -6,10 +6,12 @@ The configuration data for a field value static filter option. -Signature: +**Signature:** ```typescript type StaticFilterOptionConfig = Omit & { value: string | number | boolean; }; ``` +**References:** [FilterOptionConfig](./search-ui-react.filteroptionconfig.md) + diff --git a/docs/search-ui-react.staticfilters.md b/docs/search-ui-react.staticfilters.md index 86b96abee..84c04ecf2 100644 --- a/docs/search-ui-react.staticfilters.md +++ b/docs/search-ui-react.staticfilters.md @@ -6,7 +6,7 @@ A component that displays a group of user-configured field value filters that will be applied to the current vertical search. -Signature: +**Signature:** ```typescript declare function StaticFilters(props: StaticFiltersProps): JSX.Element; @@ -16,9 +16,9 @@ declare function StaticFilters(props: StaticFiltersProps): JSX.Element; | Parameter | Type | Description | | --- | --- | --- | -| props | StaticFiltersProps | [StaticFiltersProps](./search-ui-react.staticfiltersprops.md) | +| props | [StaticFiltersProps](./search-ui-react.staticfiltersprops.md) | [StaticFiltersProps](./search-ui-react.staticfiltersprops.md) | -Returns: +**Returns:** JSX.Element diff --git a/docs/search-ui-react.staticfilterscssclasses.md b/docs/search-ui-react.staticfilterscssclasses.md index 669914ac3..c7821c360 100644 --- a/docs/search-ui-react.staticfilterscssclasses.md +++ b/docs/search-ui-react.staticfilterscssclasses.md @@ -6,16 +6,16 @@ The CSS class interface for [StaticFilters()](./search-ui-react.staticfilters.md). -Signature: +**Signature:** ```typescript interface StaticFiltersCssClasses extends FilterGroupCssClasses ``` -Extends: FilterGroupCssClasses +**Extends:** [FilterGroupCssClasses](./search-ui-react.filtergroupcssclasses.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [staticFiltersContainer?](./search-ui-react.staticfilterscssclasses.staticfilterscontainer.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [staticFiltersContainer?](./search-ui-react.staticfilterscssclasses.staticfilterscontainer.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.staticfilterscssclasses.staticfilterscontainer.md b/docs/search-ui-react.staticfilterscssclasses.staticfilterscontainer.md index 5e194ddc2..621ed700e 100644 --- a/docs/search-ui-react.staticfilterscssclasses.staticfilterscontainer.md +++ b/docs/search-ui-react.staticfilterscssclasses.staticfilterscontainer.md @@ -4,7 +4,7 @@ ## StaticFiltersCssClasses.staticFiltersContainer property -Signature: +**Signature:** ```typescript staticFiltersContainer?: string; diff --git a/docs/search-ui-react.staticfiltersprops.collapsible.md b/docs/search-ui-react.staticfiltersprops.collapsible.md index febf545ff..58aecfe4c 100644 --- a/docs/search-ui-react.staticfiltersprops.collapsible.md +++ b/docs/search-ui-react.staticfiltersprops.collapsible.md @@ -6,7 +6,7 @@ Whether or not the filter is collapsible. Defaults to true. -Signature: +**Signature:** ```typescript collapsible?: boolean; diff --git a/docs/search-ui-react.staticfiltersprops.customcssclasses.md b/docs/search-ui-react.staticfiltersprops.customcssclasses.md index 310563ed5..7f302bec4 100644 --- a/docs/search-ui-react.staticfiltersprops.customcssclasses.md +++ b/docs/search-ui-react.staticfiltersprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: StaticFiltersCssClasses; diff --git a/docs/search-ui-react.staticfiltersprops.defaultexpanded.md b/docs/search-ui-react.staticfiltersprops.defaultexpanded.md index d2ebd5264..750ddbe12 100644 --- a/docs/search-ui-react.staticfiltersprops.defaultexpanded.md +++ b/docs/search-ui-react.staticfiltersprops.defaultexpanded.md @@ -6,7 +6,7 @@ If the filter group is collapsible, whether or not it should start out expanded. Defaults to true. -Signature: +**Signature:** ```typescript defaultExpanded?: boolean; diff --git a/docs/search-ui-react.staticfiltersprops.fieldid.md b/docs/search-ui-react.staticfiltersprops.fieldid.md index 8192cdbaf..1ea197079 100644 --- a/docs/search-ui-react.staticfiltersprops.fieldid.md +++ b/docs/search-ui-react.staticfiltersprops.fieldid.md @@ -6,7 +6,7 @@ The fieldId corresponding to the static filter group. -Signature: +**Signature:** ```typescript fieldId: string; diff --git a/docs/search-ui-react.staticfiltersprops.filteroptions.md b/docs/search-ui-react.staticfiltersprops.filteroptions.md index e5d2a9bbc..9280154b4 100644 --- a/docs/search-ui-react.staticfiltersprops.filteroptions.md +++ b/docs/search-ui-react.staticfiltersprops.filteroptions.md @@ -6,7 +6,7 @@ The configuration data for a field value static filter option. -Signature: +**Signature:** ```typescript filterOptions: StaticFilterOptionConfig[]; diff --git a/docs/search-ui-react.staticfiltersprops.md b/docs/search-ui-react.staticfiltersprops.md index 716bcc0db..40fa22dc9 100644 --- a/docs/search-ui-react.staticfiltersprops.md +++ b/docs/search-ui-react.staticfiltersprops.md @@ -6,7 +6,7 @@ Props for the [StaticFilters()](./search-ui-react.staticfilters.md) component. -Signature: +**Signature:** ```typescript interface StaticFiltersProps @@ -14,14 +14,14 @@ interface StaticFiltersProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [collapsible?](./search-ui-react.staticfiltersprops.collapsible.md) | boolean | (Optional) Whether or not the filter is collapsible. Defaults to true. | -| [customCssClasses?](./search-ui-react.staticfiltersprops.customcssclasses.md) | StaticFiltersCssClasses | (Optional) CSS classes for customizing the component styling. | -| [defaultExpanded?](./search-ui-react.staticfiltersprops.defaultexpanded.md) | boolean | (Optional) If the filter group is collapsible, whether or not it should start out expanded. Defaults to true. | -| [fieldId](./search-ui-react.staticfiltersprops.fieldid.md) | string | The fieldId corresponding to the static filter group. | -| [filterOptions](./search-ui-react.staticfiltersprops.filteroptions.md) | StaticFilterOptionConfig\[\] | The configuration data for a field value static filter option. | -| [searchable?](./search-ui-react.staticfiltersprops.searchable.md) | boolean | (Optional) Whether or not to display a text input to search for filter options. | -| [searchOnChange?](./search-ui-react.staticfiltersprops.searchonchange.md) | boolean | (Optional) Whether or not a search is automatically run when a filter is selected. Defaults to true. | -| [title](./search-ui-react.staticfiltersprops.title.md) | string | The displayed label for the static filter group. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [collapsible?](./search-ui-react.staticfiltersprops.collapsible.md) | | boolean | _(Optional)_ Whether or not the filter is collapsible. Defaults to true. | +| [customCssClasses?](./search-ui-react.staticfiltersprops.customcssclasses.md) | | [StaticFiltersCssClasses](./search-ui-react.staticfilterscssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [defaultExpanded?](./search-ui-react.staticfiltersprops.defaultexpanded.md) | | boolean | _(Optional)_ If the filter group is collapsible, whether or not it should start out expanded. Defaults to true. | +| [fieldId](./search-ui-react.staticfiltersprops.fieldid.md) | | string | The fieldId corresponding to the static filter group. | +| [filterOptions](./search-ui-react.staticfiltersprops.filteroptions.md) | | [StaticFilterOptionConfig](./search-ui-react.staticfilteroptionconfig.md)\[\] | The configuration data for a field value static filter option. | +| [searchable?](./search-ui-react.staticfiltersprops.searchable.md) | | boolean | _(Optional)_ Whether or not to display a text input to search for filter options. | +| [searchOnChange?](./search-ui-react.staticfiltersprops.searchonchange.md) | | boolean | _(Optional)_ Whether or not a search is automatically run when a filter is selected. Defaults to true. | +| [title](./search-ui-react.staticfiltersprops.title.md) | | string | The displayed label for the static filter group. | diff --git a/docs/search-ui-react.staticfiltersprops.searchable.md b/docs/search-ui-react.staticfiltersprops.searchable.md index b9908a891..85a63e161 100644 --- a/docs/search-ui-react.staticfiltersprops.searchable.md +++ b/docs/search-ui-react.staticfiltersprops.searchable.md @@ -6,7 +6,7 @@ Whether or not to display a text input to search for filter options. -Signature: +**Signature:** ```typescript searchable?: boolean; diff --git a/docs/search-ui-react.staticfiltersprops.searchonchange.md b/docs/search-ui-react.staticfiltersprops.searchonchange.md index 16eab676b..e77d4dcb0 100644 --- a/docs/search-ui-react.staticfiltersprops.searchonchange.md +++ b/docs/search-ui-react.staticfiltersprops.searchonchange.md @@ -6,7 +6,7 @@ Whether or not a search is automatically run when a filter is selected. Defaults to true. -Signature: +**Signature:** ```typescript searchOnChange?: boolean; diff --git a/docs/search-ui-react.staticfiltersprops.title.md b/docs/search-ui-react.staticfiltersprops.title.md index 3551bb75e..05c79aec9 100644 --- a/docs/search-ui-react.staticfiltersprops.title.md +++ b/docs/search-ui-react.staticfiltersprops.title.md @@ -6,7 +6,7 @@ The displayed label for the static filter group. -Signature: +**Signature:** ```typescript title: string; diff --git a/docs/search-ui-react.thumbsfeedback.md b/docs/search-ui-react.thumbsfeedback.md index b13c86e99..132f6eb91 100644 --- a/docs/search-ui-react.thumbsfeedback.md +++ b/docs/search-ui-react.thumbsfeedback.md @@ -6,7 +6,7 @@ Renders a quality feedback widget composed of thumbs up and thumbs down buttons. -Signature: +**Signature:** ```typescript declare function ThumbsFeedback(props: ThumbsFeedbackProps): JSX.Element; @@ -16,9 +16,9 @@ declare function ThumbsFeedback(props: ThumbsFeedbackProps): JSX.Element; | Parameter | Type | Description | | --- | --- | --- | -| props | ThumbsFeedbackProps | The configuration for the the feedback component. | +| props | [ThumbsFeedbackProps](./search-ui-react.thumbsfeedbackprops.md) | The configuration for the the feedback component. | -Returns: +**Returns:** JSX.Element diff --git a/docs/search-ui-react.thumbsfeedbackcssclasses.md b/docs/search-ui-react.thumbsfeedbackcssclasses.md index f23115358..5f9cc2f1a 100644 --- a/docs/search-ui-react.thumbsfeedbackcssclasses.md +++ b/docs/search-ui-react.thumbsfeedbackcssclasses.md @@ -6,7 +6,7 @@ The CSS class interface used for [ThumbsFeedback()](./search-ui-react.thumbsfeedback.md). -Signature: +**Signature:** ```typescript interface ThumbsFeedbackCssClasses @@ -14,9 +14,9 @@ interface ThumbsFeedbackCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [thumbsDownIcon?](./search-ui-react.thumbsfeedbackcssclasses.thumbsdownicon.md) | string | (Optional) | -| [thumbsFeedbackContainer?](./search-ui-react.thumbsfeedbackcssclasses.thumbsfeedbackcontainer.md) | string | (Optional) | -| [thumbsUpIcon?](./search-ui-react.thumbsfeedbackcssclasses.thumbsupicon.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [thumbsDownIcon?](./search-ui-react.thumbsfeedbackcssclasses.thumbsdownicon.md) | | string | _(Optional)_ | +| [thumbsFeedbackContainer?](./search-ui-react.thumbsfeedbackcssclasses.thumbsfeedbackcontainer.md) | | string | _(Optional)_ | +| [thumbsUpIcon?](./search-ui-react.thumbsfeedbackcssclasses.thumbsupicon.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.thumbsfeedbackcssclasses.thumbsdownicon.md b/docs/search-ui-react.thumbsfeedbackcssclasses.thumbsdownicon.md index 7a0c7e8b9..68df0f7cb 100644 --- a/docs/search-ui-react.thumbsfeedbackcssclasses.thumbsdownicon.md +++ b/docs/search-ui-react.thumbsfeedbackcssclasses.thumbsdownicon.md @@ -4,7 +4,7 @@ ## ThumbsFeedbackCssClasses.thumbsDownIcon property -Signature: +**Signature:** ```typescript thumbsDownIcon?: string; diff --git a/docs/search-ui-react.thumbsfeedbackcssclasses.thumbsfeedbackcontainer.md b/docs/search-ui-react.thumbsfeedbackcssclasses.thumbsfeedbackcontainer.md index 06e4ec3cf..17160be6a 100644 --- a/docs/search-ui-react.thumbsfeedbackcssclasses.thumbsfeedbackcontainer.md +++ b/docs/search-ui-react.thumbsfeedbackcssclasses.thumbsfeedbackcontainer.md @@ -4,7 +4,7 @@ ## ThumbsFeedbackCssClasses.thumbsFeedbackContainer property -Signature: +**Signature:** ```typescript thumbsFeedbackContainer?: string; diff --git a/docs/search-ui-react.thumbsfeedbackcssclasses.thumbsupicon.md b/docs/search-ui-react.thumbsfeedbackcssclasses.thumbsupicon.md index 1686ed07e..8bb93dcb2 100644 --- a/docs/search-ui-react.thumbsfeedbackcssclasses.thumbsupicon.md +++ b/docs/search-ui-react.thumbsfeedbackcssclasses.thumbsupicon.md @@ -4,7 +4,7 @@ ## ThumbsFeedbackCssClasses.thumbsUpIcon property -Signature: +**Signature:** ```typescript thumbsUpIcon?: string; diff --git a/docs/search-ui-react.thumbsfeedbackprops.customcssclasses.md b/docs/search-ui-react.thumbsfeedbackprops.customcssclasses.md index 80e9d0ba9..125949c63 100644 --- a/docs/search-ui-react.thumbsfeedbackprops.customcssclasses.md +++ b/docs/search-ui-react.thumbsfeedbackprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: ThumbsFeedbackCssClasses; diff --git a/docs/search-ui-react.thumbsfeedbackprops.feedbacktext.md b/docs/search-ui-react.thumbsfeedbackprops.feedbacktext.md index b65839e06..5b91ee322 100644 --- a/docs/search-ui-react.thumbsfeedbackprops.feedbacktext.md +++ b/docs/search-ui-react.thumbsfeedbackprops.feedbacktext.md @@ -6,7 +6,7 @@ Text to display alongside the quality feedback buttons. -Signature: +**Signature:** ```typescript feedbackText?: string; diff --git a/docs/search-ui-react.thumbsfeedbackprops.feedbacktextonsubmission.md b/docs/search-ui-react.thumbsfeedbackprops.feedbacktextonsubmission.md index ed74ec1a2..adaecd308 100644 --- a/docs/search-ui-react.thumbsfeedbackprops.feedbacktextonsubmission.md +++ b/docs/search-ui-react.thumbsfeedbackprops.feedbacktextonsubmission.md @@ -6,7 +6,7 @@ Text to display after a quality feedback button is clicked. -Signature: +**Signature:** ```typescript feedbackTextOnSubmission?: string; diff --git a/docs/search-ui-react.thumbsfeedbackprops.md b/docs/search-ui-react.thumbsfeedbackprops.md index ad75a2293..167ce16d7 100644 --- a/docs/search-ui-react.thumbsfeedbackprops.md +++ b/docs/search-ui-react.thumbsfeedbackprops.md @@ -6,7 +6,7 @@ Props for [ThumbsFeedback()](./search-ui-react.thumbsfeedback.md). -Signature: +**Signature:** ```typescript interface ThumbsFeedbackProps @@ -14,10 +14,10 @@ interface ThumbsFeedbackProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.thumbsfeedbackprops.customcssclasses.md) | ThumbsFeedbackCssClasses | (Optional) CSS classes for customizing the component styling. | -| [feedbackText?](./search-ui-react.thumbsfeedbackprops.feedbacktext.md) | string | (Optional) Text to display alongside the quality feedback buttons. | -| [feedbackTextOnSubmission?](./search-ui-react.thumbsfeedbackprops.feedbacktextonsubmission.md) | string | (Optional) Text to display after a quality feedback button is clicked. | -| [onClick](./search-ui-react.thumbsfeedbackprops.onclick.md) | (feedbackType: FeedbackType) => void | A function which is called when a quality feedback button is clicked. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.thumbsfeedbackprops.customcssclasses.md) | | [ThumbsFeedbackCssClasses](./search-ui-react.thumbsfeedbackcssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [feedbackText?](./search-ui-react.thumbsfeedbackprops.feedbacktext.md) | | string | _(Optional)_ Text to display alongside the quality feedback buttons. | +| [feedbackTextOnSubmission?](./search-ui-react.thumbsfeedbackprops.feedbacktextonsubmission.md) | | string | _(Optional)_ Text to display after a quality feedback button is clicked. | +| [onClick](./search-ui-react.thumbsfeedbackprops.onclick.md) | | (feedbackType: [FeedbackType](./search-ui-react.feedbacktype.md)) => void | A function which is called when a quality feedback button is clicked. | diff --git a/docs/search-ui-react.thumbsfeedbackprops.onclick.md b/docs/search-ui-react.thumbsfeedbackprops.onclick.md index eff2e4876..16b13a3cb 100644 --- a/docs/search-ui-react.thumbsfeedbackprops.onclick.md +++ b/docs/search-ui-react.thumbsfeedbackprops.onclick.md @@ -6,7 +6,7 @@ A function which is called when a quality feedback button is clicked. -Signature: +**Signature:** ```typescript onClick: (feedbackType: FeedbackType) => void; diff --git a/docs/search-ui-react.universalresults.md b/docs/search-ui-react.universalresults.md index 5e4b30d59..c6d6f99bd 100644 --- a/docs/search-ui-react.universalresults.md +++ b/docs/search-ui-react.universalresults.md @@ -6,7 +6,7 @@ Displays the results of a universal search with the results for each vertical separated into sections. -Signature: +**Signature:** ```typescript declare function UniversalResults({ verticalConfigMap, showAppliedFilters, customCssClasses }: UniversalResultsProps): JSX.Element | null; @@ -16,9 +16,9 @@ declare function UniversalResults({ verticalConfigMap, showAppliedFilters, cu | Parameter | Type | Description | | --- | --- | --- | -| { verticalConfigMap, showAppliedFilters, customCssClasses } | UniversalResultsProps<T> | | +| { verticalConfigMap, showAppliedFilters, customCssClasses } | [UniversalResultsProps](./search-ui-react.universalresultsprops.md)<T> | | -Returns: +**Returns:** JSX.Element \| null diff --git a/docs/search-ui-react.universalresultscssclasses.md b/docs/search-ui-react.universalresultscssclasses.md index 9608e61a7..5d0556fbd 100644 --- a/docs/search-ui-react.universalresultscssclasses.md +++ b/docs/search-ui-react.universalresultscssclasses.md @@ -6,17 +6,17 @@ The CSS class interface used for [UniversalResults()](./search-ui-react.universalresults.md). -Signature: +**Signature:** ```typescript interface UniversalResultsCssClasses extends SectionHeaderCssClasses ``` -Extends: SectionHeaderCssClasses +**Extends:** [SectionHeaderCssClasses](./search-ui-react.sectionheadercssclasses.md) ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [universalResultsContainer?](./search-ui-react.universalresultscssclasses.universalresultscontainer.md) | string | (Optional) | -| [universalResultsLoading?](./search-ui-react.universalresultscssclasses.universalresultsloading.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [universalResultsContainer?](./search-ui-react.universalresultscssclasses.universalresultscontainer.md) | | string | _(Optional)_ | +| [universalResultsLoading?](./search-ui-react.universalresultscssclasses.universalresultsloading.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.universalresultscssclasses.universalresultscontainer.md b/docs/search-ui-react.universalresultscssclasses.universalresultscontainer.md index 1d3eb75b6..17d16ce92 100644 --- a/docs/search-ui-react.universalresultscssclasses.universalresultscontainer.md +++ b/docs/search-ui-react.universalresultscssclasses.universalresultscontainer.md @@ -4,7 +4,7 @@ ## UniversalResultsCssClasses.universalResultsContainer property -Signature: +**Signature:** ```typescript universalResultsContainer?: string; diff --git a/docs/search-ui-react.universalresultscssclasses.universalresultsloading.md b/docs/search-ui-react.universalresultscssclasses.universalresultsloading.md index 598934f43..e20a41b30 100644 --- a/docs/search-ui-react.universalresultscssclasses.universalresultsloading.md +++ b/docs/search-ui-react.universalresultscssclasses.universalresultsloading.md @@ -4,7 +4,7 @@ ## UniversalResultsCssClasses.universalResultsLoading property -Signature: +**Signature:** ```typescript universalResultsLoading?: string; diff --git a/docs/search-ui-react.universalresultsprops.customcssclasses.md b/docs/search-ui-react.universalresultsprops.customcssclasses.md index a92eaad02..7a960147a 100644 --- a/docs/search-ui-react.universalresultsprops.customcssclasses.md +++ b/docs/search-ui-react.universalresultsprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: UniversalResultsCssClasses; diff --git a/docs/search-ui-react.universalresultsprops.md b/docs/search-ui-react.universalresultsprops.md index 84550c846..37529ce11 100644 --- a/docs/search-ui-react.universalresultsprops.md +++ b/docs/search-ui-react.universalresultsprops.md @@ -6,7 +6,7 @@ Props for [UniversalResults()](./search-ui-react.universalresults.md). -Signature: +**Signature:** ```typescript interface UniversalResultsProps @@ -14,9 +14,9 @@ interface UniversalResultsProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [customCssClasses?](./search-ui-react.universalresultsprops.customcssclasses.md) | UniversalResultsCssClasses | (Optional) CSS classes for customizing the component styling. | -| [showAppliedFilters?](./search-ui-react.universalresultsprops.showappliedfilters.md) | boolean | (Optional) Whether or not to show the applied filters. | -| [verticalConfigMap](./search-ui-react.universalresultsprops.verticalconfigmap.md) | VerticalConfigMap<T> | A mapping of verticalKey to the configuration for each vertical. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [customCssClasses?](./search-ui-react.universalresultsprops.customcssclasses.md) | | [UniversalResultsCssClasses](./search-ui-react.universalresultscssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [showAppliedFilters?](./search-ui-react.universalresultsprops.showappliedfilters.md) | | boolean | _(Optional)_ Whether or not to show the applied filters. | +| [verticalConfigMap](./search-ui-react.universalresultsprops.verticalconfigmap.md) | | [VerticalConfigMap](./search-ui-react.verticalconfigmap.md)<T> | A mapping of verticalKey to the configuration for each vertical. | diff --git a/docs/search-ui-react.universalresultsprops.showappliedfilters.md b/docs/search-ui-react.universalresultsprops.showappliedfilters.md index 5ad2d8c0c..3f2d5fe11 100644 --- a/docs/search-ui-react.universalresultsprops.showappliedfilters.md +++ b/docs/search-ui-react.universalresultsprops.showappliedfilters.md @@ -6,7 +6,7 @@ Whether or not to show the applied filters. -Signature: +**Signature:** ```typescript showAppliedFilters?: boolean; diff --git a/docs/search-ui-react.universalresultsprops.verticalconfigmap.md b/docs/search-ui-react.universalresultsprops.verticalconfigmap.md index 5c76e2fcc..ce06a276a 100644 --- a/docs/search-ui-react.universalresultsprops.verticalconfigmap.md +++ b/docs/search-ui-react.universalresultsprops.verticalconfigmap.md @@ -6,7 +6,7 @@ A mapping of verticalKey to the configuration for each vertical. -Signature: +**Signature:** ```typescript verticalConfigMap: VerticalConfigMap; diff --git a/docs/search-ui-react.unknownfieldtypedisplaycomponent.md b/docs/search-ui-react.unknownfieldtypedisplaycomponent.md index 3d8ca6711..919bd1189 100644 --- a/docs/search-ui-react.unknownfieldtypedisplaycomponent.md +++ b/docs/search-ui-react.unknownfieldtypedisplaycomponent.md @@ -6,8 +6,10 @@ A React component interface to render results with "unknown" field type in field value direct answer. -Signature: +**Signature:** ```typescript type UnknownFieldTypeDisplayComponent = (props: UnknownFieldTypeDisplayProps) => JSX.Element; ``` +**References:** [UnknownFieldTypeDisplayProps](./search-ui-react.unknownfieldtypedisplayprops.md) + diff --git a/docs/search-ui-react.unknownfieldtypedisplayprops.md b/docs/search-ui-react.unknownfieldtypedisplayprops.md index eb2ff4ce8..56ce7fd82 100644 --- a/docs/search-ui-react.unknownfieldtypedisplayprops.md +++ b/docs/search-ui-react.unknownfieldtypedisplayprops.md @@ -6,7 +6,7 @@ Props for [UnknownFieldTypeDisplayComponent](./search-ui-react.unknownfieldtypedisplaycomponent.md). -Signature: +**Signature:** ```typescript interface UnknownFieldTypeDisplayProps @@ -14,7 +14,7 @@ interface UnknownFieldTypeDisplayProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [result](./search-ui-react.unknownfieldtypedisplayprops.result.md) | UnknownFieldValueDirectAnswer | | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [result](./search-ui-react.unknownfieldtypedisplayprops.result.md) | | UnknownFieldValueDirectAnswer | | diff --git a/docs/search-ui-react.unknownfieldtypedisplayprops.result.md b/docs/search-ui-react.unknownfieldtypedisplayprops.result.md index bc102e751..ec04c6c9a 100644 --- a/docs/search-ui-react.unknownfieldtypedisplayprops.result.md +++ b/docs/search-ui-react.unknownfieldtypedisplayprops.result.md @@ -4,7 +4,7 @@ ## UnknownFieldTypeDisplayProps.result property -Signature: +**Signature:** ```typescript result: UnknownFieldValueDirectAnswer; diff --git a/docs/search-ui-react.updatelocationifneeded.md b/docs/search-ui-react.updatelocationifneeded.md index 230e0bf06..f4f3004f8 100644 --- a/docs/search-ui-react.updatelocationifneeded.md +++ b/docs/search-ui-react.updatelocationifneeded.md @@ -6,7 +6,7 @@ If the provided search intents include a 'NEAR\_ME' intent and there's no existing user's location in state, retrieve and store user's location in headless state. -Signature: +**Signature:** ```typescript declare function updateLocationIfNeeded(searchActions: SearchActions, intents: SearchIntent[], geolocationOptions?: PositionOptions): Promise; @@ -18,9 +18,9 @@ declare function updateLocationIfNeeded(searchActions: SearchActions, intents: S | --- | --- | --- | | searchActions | SearchActions | | | intents | SearchIntent\[\] | | -| geolocationOptions | PositionOptions | | +| geolocationOptions | PositionOptions | _(Optional)_ | -Returns: +**Returns:** Promise<void> diff --git a/docs/search-ui-react.useanalytics.md b/docs/search-ui-react.useanalytics.md index a66cd2cf2..0c6de6171 100644 --- a/docs/search-ui-react.useanalytics.md +++ b/docs/search-ui-react.useanalytics.md @@ -6,12 +6,12 @@ Returns a service that can be used to report analytics events. -Signature: +**Signature:** ```typescript declare function useAnalytics(): AnalyticsService | null; ``` -Returns: +**Returns:** AnalyticsService \| null diff --git a/docs/search-ui-react.usecardanalyticscallback.md b/docs/search-ui-react.usecardanalyticscallback.md index 1d93b4d15..302e724e8 100644 --- a/docs/search-ui-react.usecardanalyticscallback.md +++ b/docs/search-ui-react.usecardanalyticscallback.md @@ -6,7 +6,7 @@ Creates a memoized function for reporting card analytics. -Signature: +**Signature:** ```typescript declare function useCardAnalyticsCallback(result: CardAnalyticsDataType, analyticsType: CardAnalyticsType): () => void; @@ -16,10 +16,10 @@ declare function useCardAnalyticsCallback(result: CardAn | Parameter | Type | Description | | --- | --- | --- | -| result | CardAnalyticsDataType<T> | result that contains data use in the card analytics event. | -| analyticsType | CardAnalyticsType | the card analytics event type to report. | +| result | [CardAnalyticsDataType](./search-ui-react.cardanalyticsdatatype.md)<T> | result that contains data use in the card analytics event. | +| analyticsType | [CardAnalyticsType](./search-ui-react.cardanalyticstype.md) | the card analytics event type to report. | -Returns: +**Returns:** () => void diff --git a/docs/search-ui-react.usecardfeedbackcallback.md b/docs/search-ui-react.usecardfeedbackcallback.md index b0a021e43..f2b66465a 100644 --- a/docs/search-ui-react.usecardfeedbackcallback.md +++ b/docs/search-ui-react.usecardfeedbackcallback.md @@ -6,7 +6,7 @@ Creates a memoized function for reporting card feedback analytics. -Signature: +**Signature:** ```typescript declare function useCardFeedbackCallback(result: CardAnalyticsDataType): (analyticsType: FeedbackType) => void; @@ -16,9 +16,9 @@ declare function useCardFeedbackCallback(result: CardAna | Parameter | Type | Description | | --- | --- | --- | -| result | CardAnalyticsDataType<T> | card result that contains data use in the feedback analytics event. | +| result | [CardAnalyticsDataType](./search-ui-react.cardanalyticsdatatype.md)<T> | card result that contains data use in the feedback analytics event. | -Returns: +**Returns:** -(analyticsType: FeedbackType) => void +(analyticsType: [FeedbackType](./search-ui-react.feedbacktype.md)) => void diff --git a/docs/search-ui-react.usecomposedcssclasses.md b/docs/search-ui-react.usecomposedcssclasses.md index f840cb87f..1f67c9b60 100644 --- a/docs/search-ui-react.usecomposedcssclasses.md +++ b/docs/search-ui-react.usecomposedcssclasses.md @@ -6,7 +6,7 @@ useComposedCssClasses merges a component's built-in tailwind classes with custom tailwind classes. -Signature: +**Signature:** ```typescript declare function useComposedCssClasses>>(builtInClasses: Readonly, customClasses?: Partial): ClassInterface; @@ -17,9 +17,9 @@ declare function useComposedCssClassesReturns: +**Returns:** ClassInterface diff --git a/docs/search-ui-react.verticalconfig.cardcomponent.md b/docs/search-ui-react.verticalconfig.cardcomponent.md index 8307da2c1..a04bd9d3b 100644 --- a/docs/search-ui-react.verticalconfig.cardcomponent.md +++ b/docs/search-ui-react.verticalconfig.cardcomponent.md @@ -6,7 +6,7 @@ The card to use for this vertical. -Signature: +**Signature:** ```typescript CardComponent?: CardComponent; diff --git a/docs/search-ui-react.verticalconfig.getviewallurl.md b/docs/search-ui-react.verticalconfig.getviewallurl.md index ec029f3ca..a625827c9 100644 --- a/docs/search-ui-react.verticalconfig.getviewallurl.md +++ b/docs/search-ui-react.verticalconfig.getviewallurl.md @@ -6,7 +6,7 @@ A function to provide user defined url path for each vertical's view all link. -Signature: +**Signature:** ```typescript getViewAllUrl?: (data: VerticalLink) => string; diff --git a/docs/search-ui-react.verticalconfig.label.md b/docs/search-ui-react.verticalconfig.label.md index 0a779cccb..0e87f823d 100644 --- a/docs/search-ui-react.verticalconfig.label.md +++ b/docs/search-ui-react.verticalconfig.label.md @@ -6,7 +6,7 @@ The label for the vertical. -Signature: +**Signature:** ```typescript label?: string; diff --git a/docs/search-ui-react.verticalconfig.md b/docs/search-ui-react.verticalconfig.md index 9f516523d..577829d2c 100644 --- a/docs/search-ui-react.verticalconfig.md +++ b/docs/search-ui-react.verticalconfig.md @@ -6,7 +6,7 @@ The configuration for a vertical. -Signature: +**Signature:** ```typescript interface VerticalConfig @@ -14,11 +14,11 @@ interface VerticalConfig ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [CardComponent?](./search-ui-react.verticalconfig.cardcomponent.md) | CardComponent<T> | (Optional) The card to use for this vertical. | -| [getViewAllUrl?](./search-ui-react.verticalconfig.getviewallurl.md) | (data: VerticalLink) => string | (Optional) A function to provide user defined url path for each vertical's view all link. | -| [label?](./search-ui-react.verticalconfig.label.md) | string | (Optional) The label for the vertical. | -| [SectionComponent?](./search-ui-react.verticalconfig.sectioncomponent.md) | SectionComponent<T> | (Optional) A component that can be used to render a section template for vertical results. | -| [viewAllButton?](./search-ui-react.verticalconfig.viewallbutton.md) | boolean | (Optional) Whether or not this vertical should show a button to view all results on the vertical page. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [CardComponent?](./search-ui-react.verticalconfig.cardcomponent.md) | | [CardComponent](./search-ui-react.cardcomponent.md)<T> | _(Optional)_ The card to use for this vertical. | +| [getViewAllUrl?](./search-ui-react.verticalconfig.getviewallurl.md) | | (data: [VerticalLink](./search-ui-react.verticallink.md)) => string | _(Optional)_ A function to provide user defined url path for each vertical's view all link. | +| [label?](./search-ui-react.verticalconfig.label.md) | | string | _(Optional)_ The label for the vertical. | +| [SectionComponent?](./search-ui-react.verticalconfig.sectioncomponent.md) | | [SectionComponent](./search-ui-react.sectioncomponent.md)<T> | _(Optional)_ A component that can be used to render a section template for vertical results. | +| [viewAllButton?](./search-ui-react.verticalconfig.viewallbutton.md) | | boolean | _(Optional)_ Whether or not this vertical should show a button to view all results on the vertical page. | diff --git a/docs/search-ui-react.verticalconfig.sectioncomponent.md b/docs/search-ui-react.verticalconfig.sectioncomponent.md index 067b64c1c..27c7023f8 100644 --- a/docs/search-ui-react.verticalconfig.sectioncomponent.md +++ b/docs/search-ui-react.verticalconfig.sectioncomponent.md @@ -6,7 +6,7 @@ A component that can be used to render a section template for vertical results. -Signature: +**Signature:** ```typescript SectionComponent?: SectionComponent; diff --git a/docs/search-ui-react.verticalconfig.viewallbutton.md b/docs/search-ui-react.verticalconfig.viewallbutton.md index 3d32780a0..14929e45b 100644 --- a/docs/search-ui-react.verticalconfig.viewallbutton.md +++ b/docs/search-ui-react.verticalconfig.viewallbutton.md @@ -6,7 +6,7 @@ Whether or not this vertical should show a button to view all results on the vertical page. -Signature: +**Signature:** ```typescript viewAllButton?: boolean; diff --git a/docs/search-ui-react.verticalconfigmap.md b/docs/search-ui-react.verticalconfigmap.md index efa7849ec..5729341bc 100644 --- a/docs/search-ui-react.verticalconfigmap.md +++ b/docs/search-ui-react.verticalconfigmap.md @@ -6,10 +6,12 @@ A map of verticalKey to a VerticalConfig. -Signature: +**Signature:** ```typescript type VerticalConfigMap> = { [K in keyof T]: VerticalConfig; }; ``` +**References:** [DefaultRawDataType](./search-ui-react.defaultrawdatatype.md), [VerticalConfig](./search-ui-react.verticalconfig.md) + diff --git a/docs/search-ui-react.verticallabelmap.md b/docs/search-ui-react.verticallabelmap.md index 2799c6b8a..ead079b84 100644 --- a/docs/search-ui-react.verticallabelmap.md +++ b/docs/search-ui-react.verticallabelmap.md @@ -6,7 +6,7 @@ A map of vertical keys to labels. -Signature: +**Signature:** ```typescript interface VerticalLabelMap diff --git a/docs/search-ui-react.verticallink.md b/docs/search-ui-react.verticallink.md index 77b030d8a..20211fa19 100644 --- a/docs/search-ui-react.verticallink.md +++ b/docs/search-ui-react.verticallink.md @@ -6,7 +6,7 @@ Data needed to create a URL to a vertical search page. -Signature: +**Signature:** ```typescript interface VerticalLink @@ -14,8 +14,8 @@ interface VerticalLink ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [query?](./search-ui-react.verticallink.query.md) | string | (Optional) The query used when the vertical link is selected. | -| [verticalKey](./search-ui-react.verticallink.verticalkey.md) | string | The vertical key associated with the vertical link. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [query?](./search-ui-react.verticallink.query.md) | | string | _(Optional)_ The query used when the vertical link is selected. | +| [verticalKey](./search-ui-react.verticallink.verticalkey.md) | | string | The vertical key associated with the vertical link. | diff --git a/docs/search-ui-react.verticallink.query.md b/docs/search-ui-react.verticallink.query.md index 0673ecc92..27c59814f 100644 --- a/docs/search-ui-react.verticallink.query.md +++ b/docs/search-ui-react.verticallink.query.md @@ -6,7 +6,7 @@ The query used when the vertical link is selected. -Signature: +**Signature:** ```typescript query?: string; diff --git a/docs/search-ui-react.verticallink.verticalkey.md b/docs/search-ui-react.verticallink.verticalkey.md index 43274592d..228766db7 100644 --- a/docs/search-ui-react.verticallink.verticalkey.md +++ b/docs/search-ui-react.verticallink.verticalkey.md @@ -6,7 +6,7 @@ The vertical key associated with the vertical link. -Signature: +**Signature:** ```typescript verticalKey: string; diff --git a/docs/search-ui-react.verticalresults.md b/docs/search-ui-react.verticalresults.md index fad586803..ff5477d03 100644 --- a/docs/search-ui-react.verticalresults.md +++ b/docs/search-ui-react.verticalresults.md @@ -6,7 +6,7 @@ A component that renders search results for a vertical page. -Signature: +**Signature:** ```typescript declare function VerticalResults(props: VerticalResultsProps): JSX.Element | null; @@ -16,9 +16,9 @@ declare function VerticalResults(props: VerticalResultsProps): JSX.Element | Parameter | Type | Description | | --- | --- | --- | -| props | VerticalResultsProps<T> | [VerticalResultsProps](./search-ui-react.verticalresultsprops.md) | +| props | [VerticalResultsProps](./search-ui-react.verticalresultsprops.md)<T> | [VerticalResultsProps](./search-ui-react.verticalresultsprops.md) | -Returns: +**Returns:** JSX.Element \| null diff --git a/docs/search-ui-react.verticalresultscssclasses.md b/docs/search-ui-react.verticalresultscssclasses.md index 3efd38c73..df0c478da 100644 --- a/docs/search-ui-react.verticalresultscssclasses.md +++ b/docs/search-ui-react.verticalresultscssclasses.md @@ -6,7 +6,7 @@ The CSS class interface used for [VerticalResults()](./search-ui-react.verticalresults.md). -Signature: +**Signature:** ```typescript interface VerticalResultsCssClasses @@ -14,8 +14,8 @@ interface VerticalResultsCssClasses ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [verticalResultsContainer?](./search-ui-react.verticalresultscssclasses.verticalresultscontainer.md) | string | (Optional) | -| [verticalResultsLoading?](./search-ui-react.verticalresultscssclasses.verticalresultsloading.md) | string | (Optional) | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [verticalResultsContainer?](./search-ui-react.verticalresultscssclasses.verticalresultscontainer.md) | | string | _(Optional)_ | +| [verticalResultsLoading?](./search-ui-react.verticalresultscssclasses.verticalresultsloading.md) | | string | _(Optional)_ | diff --git a/docs/search-ui-react.verticalresultscssclasses.verticalresultscontainer.md b/docs/search-ui-react.verticalresultscssclasses.verticalresultscontainer.md index a7121ef7d..1c31a21e6 100644 --- a/docs/search-ui-react.verticalresultscssclasses.verticalresultscontainer.md +++ b/docs/search-ui-react.verticalresultscssclasses.verticalresultscontainer.md @@ -4,7 +4,7 @@ ## VerticalResultsCssClasses.verticalResultsContainer property -Signature: +**Signature:** ```typescript verticalResultsContainer?: string; diff --git a/docs/search-ui-react.verticalresultscssclasses.verticalresultsloading.md b/docs/search-ui-react.verticalresultscssclasses.verticalresultsloading.md index 7229dbf76..9a9a99658 100644 --- a/docs/search-ui-react.verticalresultscssclasses.verticalresultsloading.md +++ b/docs/search-ui-react.verticalresultscssclasses.verticalresultsloading.md @@ -4,7 +4,7 @@ ## VerticalResultsCssClasses.verticalResultsLoading property -Signature: +**Signature:** ```typescript verticalResultsLoading?: string; diff --git a/docs/search-ui-react.verticalresultsprops.cardcomponent.md b/docs/search-ui-react.verticalresultsprops.cardcomponent.md index 61e5fd146..873ac063b 100644 --- a/docs/search-ui-react.verticalresultsprops.cardcomponent.md +++ b/docs/search-ui-react.verticalresultsprops.cardcomponent.md @@ -6,7 +6,7 @@ A functional component that can be used to render a result card. -Signature: +**Signature:** ```typescript CardComponent: CardComponent; diff --git a/docs/search-ui-react.verticalresultsprops.customcssclasses.md b/docs/search-ui-react.verticalresultsprops.customcssclasses.md index 81b090016..5eb4293bf 100644 --- a/docs/search-ui-react.verticalresultsprops.customcssclasses.md +++ b/docs/search-ui-react.verticalresultsprops.customcssclasses.md @@ -6,7 +6,7 @@ CSS classes for customizing the component styling. -Signature: +**Signature:** ```typescript customCssClasses?: VerticalResultsCssClasses; diff --git a/docs/search-ui-react.verticalresultsprops.displayallonnoresults.md b/docs/search-ui-react.verticalresultsprops.displayallonnoresults.md index 833c87874..2ec813557 100644 --- a/docs/search-ui-react.verticalresultsprops.displayallonnoresults.md +++ b/docs/search-ui-react.verticalresultsprops.displayallonnoresults.md @@ -6,7 +6,7 @@ Whether or not all results should be displayed when there are none returned from the search. Defaults to true. -Signature: +**Signature:** ```typescript displayAllOnNoResults?: boolean; diff --git a/docs/search-ui-react.verticalresultsprops.md b/docs/search-ui-react.verticalresultsprops.md index 4ab1d4b9d..c2948d3d7 100644 --- a/docs/search-ui-react.verticalresultsprops.md +++ b/docs/search-ui-react.verticalresultsprops.md @@ -6,7 +6,7 @@ Props for the VerticalResults component. -Signature: +**Signature:** ```typescript interface VerticalResultsProps @@ -14,9 +14,9 @@ interface VerticalResultsProps ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [CardComponent](./search-ui-react.verticalresultsprops.cardcomponent.md) | CardComponent<T> | A functional component that can be used to render a result card. | -| [customCssClasses?](./search-ui-react.verticalresultsprops.customcssclasses.md) | VerticalResultsCssClasses | (Optional) CSS classes for customizing the component styling. | -| [displayAllOnNoResults?](./search-ui-react.verticalresultsprops.displayallonnoresults.md) | boolean | (Optional) Whether or not all results should be displayed when there are none returned from the search. Defaults to true. | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [CardComponent](./search-ui-react.verticalresultsprops.cardcomponent.md) | | [CardComponent](./search-ui-react.cardcomponent.md)<T> | A functional component that can be used to render a result card. | +| [customCssClasses?](./search-ui-react.verticalresultsprops.customcssclasses.md) | | [VerticalResultsCssClasses](./search-ui-react.verticalresultscssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. | +| [displayAllOnNoResults?](./search-ui-react.verticalresultsprops.displayallonnoresults.md) | | boolean | _(Optional)_ Whether or not all results should be displayed when there are none returned from the search. Defaults to true. | diff --git a/docs/search-ui-react.visualautocompleteconfig.entitypreviewsdebouncingtime.md b/docs/search-ui-react.visualautocompleteconfig.entitypreviewsdebouncingtime.md index d715e8f09..4f23c4b36 100644 --- a/docs/search-ui-react.visualautocompleteconfig.entitypreviewsdebouncingtime.md +++ b/docs/search-ui-react.visualautocompleteconfig.entitypreviewsdebouncingtime.md @@ -6,7 +6,7 @@ The debouncing time, in milliseconds, for making API requests for entity previews. -Signature: +**Signature:** ```typescript entityPreviewsDebouncingTime?: number; diff --git a/docs/search-ui-react.visualautocompleteconfig.entitypreviewsearcher.md b/docs/search-ui-react.visualautocompleteconfig.entitypreviewsearcher.md index 052e3082d..27342d67b 100644 --- a/docs/search-ui-react.visualautocompleteconfig.entitypreviewsearcher.md +++ b/docs/search-ui-react.visualautocompleteconfig.entitypreviewsearcher.md @@ -6,7 +6,7 @@ The Search Headless instance used to perform visual autocomplete searches. -Signature: +**Signature:** ```typescript entityPreviewSearcher: SearchHeadless; diff --git a/docs/search-ui-react.visualautocompleteconfig.includedverticals.md b/docs/search-ui-react.visualautocompleteconfig.includedverticals.md index baadd2030..c3b64a9ee 100644 --- a/docs/search-ui-react.visualautocompleteconfig.includedverticals.md +++ b/docs/search-ui-react.visualautocompleteconfig.includedverticals.md @@ -6,7 +6,7 @@ Specify which verticals to include for VisualAutocomplete. -Signature: +**Signature:** ```typescript includedVerticals: string[]; diff --git a/docs/search-ui-react.visualautocompleteconfig.md b/docs/search-ui-react.visualautocompleteconfig.md index 796ba9425..abe87befd 100644 --- a/docs/search-ui-react.visualautocompleteconfig.md +++ b/docs/search-ui-react.visualautocompleteconfig.md @@ -6,7 +6,7 @@ The configuration options for Visual Autocomplete. -Signature: +**Signature:** ```typescript interface VisualAutocompleteConfig @@ -14,11 +14,11 @@ interface VisualAutocompleteConfig ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [entityPreviewsDebouncingTime?](./search-ui-react.visualautocompleteconfig.entitypreviewsdebouncingtime.md) | number | (Optional) The debouncing time, in milliseconds, for making API requests for entity previews. | -| [entityPreviewSearcher](./search-ui-react.visualautocompleteconfig.entitypreviewsearcher.md) | SearchHeadless | The Search Headless instance used to perform visual autocomplete searches. | -| [includedVerticals](./search-ui-react.visualautocompleteconfig.includedverticals.md) | string\[\] | Specify which verticals to include for VisualAutocomplete. | -| [renderEntityPreviews](./search-ui-react.visualautocompleteconfig.renderentitypreviews.md) | RenderEntityPreviews | Renders entity previews based on the autocomplete loading state and results. | -| [universalLimit?](./search-ui-react.visualautocompleteconfig.universallimit.md) | UniversalLimit | (Optional) Specify the number of entities to return per vertical. \* | +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [entityPreviewsDebouncingTime?](./search-ui-react.visualautocompleteconfig.entitypreviewsdebouncingtime.md) | | number | _(Optional)_ The debouncing time, in milliseconds, for making API requests for entity previews. | +| [entityPreviewSearcher](./search-ui-react.visualautocompleteconfig.entitypreviewsearcher.md) | | SearchHeadless | The Search Headless instance used to perform visual autocomplete searches. | +| [includedVerticals](./search-ui-react.visualautocompleteconfig.includedverticals.md) | | string\[\] | Specify which verticals to include for VisualAutocomplete. | +| [renderEntityPreviews](./search-ui-react.visualautocompleteconfig.renderentitypreviews.md) | | [RenderEntityPreviews](./search-ui-react.renderentitypreviews.md) | Renders entity previews based on the autocomplete loading state and results. | +| [universalLimit?](./search-ui-react.visualautocompleteconfig.universallimit.md) | | UniversalLimit | _(Optional)_ Specify the number of entities to return per vertical. \* | diff --git a/docs/search-ui-react.visualautocompleteconfig.renderentitypreviews.md b/docs/search-ui-react.visualautocompleteconfig.renderentitypreviews.md index cb9e7d860..2d8a573b5 100644 --- a/docs/search-ui-react.visualautocompleteconfig.renderentitypreviews.md +++ b/docs/search-ui-react.visualautocompleteconfig.renderentitypreviews.md @@ -6,7 +6,7 @@ Renders entity previews based on the autocomplete loading state and results. -Signature: +**Signature:** ```typescript renderEntityPreviews: RenderEntityPreviews; diff --git a/docs/search-ui-react.visualautocompleteconfig.universallimit.md b/docs/search-ui-react.visualautocompleteconfig.universallimit.md index 66eeddff6..fe1cf1999 100644 --- a/docs/search-ui-react.visualautocompleteconfig.universallimit.md +++ b/docs/search-ui-react.visualautocompleteconfig.universallimit.md @@ -6,7 +6,7 @@ Specify the number of entities to return per vertical. \* -Signature: +**Signature:** ```typescript universalLimit?: UniversalLimit; diff --git a/etc/search-ui-react.api.md b/etc/search-ui-react.api.md index 001517aae..cc5f7ecc2 100644 --- a/etc/search-ui-react.api.md +++ b/etc/search-ui-react.api.md @@ -202,7 +202,7 @@ export function executeSearch(searchActions: SearchActions): Promise; export type FacetProps = StandardFacetProps | NumericalFacetProps | HierarchicalFacetProps; // @public -export function Facets(props: FacetsProps): React_2.JSX.Element; +export function Facets(props: FacetsProps): JSX.Element; // @public export interface FacetsCssClasses extends FilterGroupCssClasses { @@ -364,7 +364,7 @@ export interface HierarchicalFacetProps extends Omit({ mapboxAccessToken, mapboxOptions, PinComponent, getCoordinate, onDrag }: MapboxMapProps): React_2.JSX.Element; +export function MapboxMap({ mapboxAccessToken, mapboxOptions, PinComponent, getCoordinate, onDrag }: MapboxMapProps): JSX.Element; // @public export interface MapboxMapProps { @@ -440,7 +440,7 @@ export interface NumericalFacetProps extends StandardFacetProps { } // @public @deprecated -export function NumericalFacets({ searchOnChange, includedFieldIds, getFilterDisplayName, inputPrefix, customCssClasses, ...filterGroupProps }: NumericalFacetsProps): React_2.JSX.Element; +export function NumericalFacets({ searchOnChange, includedFieldIds, getFilterDisplayName, inputPrefix, customCssClasses, ...filterGroupProps }: NumericalFacetsProps): JSX.Element; // @public export interface NumericalFacetsCssClasses extends FilterGroupCssClasses, RangeInputCssClasses { @@ -728,7 +728,7 @@ export interface StandardFacetProps { } // @public @deprecated -export function StandardFacets(props: StandardFacetsProps): React_2.JSX.Element; +export function StandardFacets(props: StandardFacetsProps): JSX.Element; // @public @deprecated export interface StandardFacetsCssClasses extends FilterGroupCssClasses { diff --git a/package-lock.json b/package-lock.json index c9f625991..18b9af387 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,16 +1,14 @@ { "name": "@yext/search-ui-react", - "version": "1.4.0", + "version": "1.4.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@yext/search-ui-react", - "version": "1.4.0", + "version": "1.4.1", "license": "BSD-3-Clause", "dependencies": { - "@microsoft/api-documenter": "^7.15.3", - "@microsoft/api-extractor": "^7.19.4", "@reach/auto-id": "^0.18.0", "@restart/ui": "^1.0.1", "@tailwindcss/forms": "^0.5.0", @@ -31,6 +29,8 @@ "@babel/preset-react": "^7.16.7", "@babel/preset-typescript": "^7.14.5", "@etchteam/storybook-addon-status": "^4.2.4", + "@microsoft/api-documenter": "^7.23.14", + "@microsoft/api-extractor": "^7.38.5", "@reduxjs/toolkit": "^1.8.6", "@storybook/addon-a11y": "^7.4.5", "@storybook/addon-actions": "^7.4.5", @@ -72,7 +72,7 @@ "storybook": "^7.4.5", "tailwindcss": "^3.0.23", "ts-jest": "^29.1.1", - "tsup": "^7.2.0", + "tsup": "^8.0.1", "typescript": "^5.2.2" }, "peerDependencies": { @@ -2348,6 +2348,54 @@ "react": ">=16.8.0" } }, + "node_modules/@esbuild/android-arm": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.19.9.tgz", + "integrity": "sha512-jkYjjq7SdsWuNI6b5quymW0oC83NN5FdRPuCbs9HZ02mfVdAP8B8eeqLSYU3gb6OJEaY5CQabtTFbqBf26H3GA==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.19.9.tgz", + "integrity": "sha512-q4cR+6ZD0938R19MyEW3jEsMzbb/1rulLXiNAJQADD/XYp7pT+rOS5JGxvpRW8dFDEfjW4wLgC/3FXIw4zYglQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.19.9.tgz", + "integrity": "sha512-KOqoPntWAH6ZxDwx1D6mRntIgZh9KodzgNOy5Ebt9ghzffOk9X2c1sPwtM9P+0eXbefnDhqYfkh5PLP5ULtWFA==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, "node_modules/@esbuild/darwin-arm64": { "version": "0.18.20", "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.18.20.tgz", @@ -2364,6 +2412,294 @@ "node": ">=12" } }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.19.9.tgz", + "integrity": "sha512-vE0VotmNTQaTdX0Q9dOHmMTao6ObjyPm58CHZr1UK7qpNleQyxlFlNCaHsHx6Uqv86VgPmR4o2wdNq3dP1qyDQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.19.9.tgz", + "integrity": "sha512-uFQyd/o1IjiEk3rUHSwUKkqZwqdvuD8GevWF065eqgYfexcVkxh+IJgwTaGZVu59XczZGcN/YMh9uF1fWD8j1g==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.19.9.tgz", + "integrity": "sha512-WMLgWAtkdTbTu1AWacY7uoj/YtHthgqrqhf1OaEWnZb7PQgpt8eaA/F3LkV0E6K/Lc0cUr/uaVP/49iE4M4asA==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.19.9.tgz", + "integrity": "sha512-C/ChPohUYoyUaqn1h17m/6yt6OB14hbXvT8EgM1ZWaiiTYz7nWZR0SYmMnB5BzQA4GXl3BgBO1l8MYqL/He3qw==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.19.9.tgz", + "integrity": "sha512-PiPblfe1BjK7WDAKR1Cr9O7VVPqVNpwFcPWgfn4xu0eMemzRp442hXyzF/fSwgrufI66FpHOEJk0yYdPInsmyQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.19.9.tgz", + "integrity": "sha512-f37i/0zE0MjDxijkPSQw1CO/7C27Eojqb+r3BbHVxMLkj8GCa78TrBZzvPyA/FNLUMzP3eyHCVkAopkKVja+6Q==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.19.9.tgz", + "integrity": "sha512-t6mN147pUIf3t6wUt3FeumoOTPfmv9Cc6DQlsVBpB7eCpLOqQDyWBP1ymXn1lDw4fNUSb/gBcKAmvTP49oIkaA==", + "cpu": [ + "loong64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.19.9.tgz", + "integrity": "sha512-jg9fujJTNTQBuDXdmAg1eeJUL4Jds7BklOTkkH80ZgQIoCTdQrDaHYgbFZyeTq8zbY+axgptncko3v9p5hLZtw==", + "cpu": [ + "mips64el" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.19.9.tgz", + "integrity": "sha512-tkV0xUX0pUUgY4ha7z5BbDS85uI7ABw3V1d0RNTii7E9lbmV8Z37Pup2tsLV46SQWzjOeyDi1Q7Wx2+QM8WaCQ==", + "cpu": [ + "ppc64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.19.9.tgz", + "integrity": "sha512-DfLp8dj91cufgPZDXr9p3FoR++m3ZJ6uIXsXrIvJdOjXVREtXuQCjfMfvmc3LScAVmLjcfloyVtpn43D56JFHg==", + "cpu": [ + "riscv64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.19.9.tgz", + "integrity": "sha512-zHbglfEdC88KMgCWpOl/zc6dDYJvWGLiUtmPRsr1OgCViu3z5GncvNVdf+6/56O2Ca8jUU+t1BW261V6kp8qdw==", + "cpu": [ + "s390x" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.19.9.tgz", + "integrity": "sha512-JUjpystGFFmNrEHQnIVG8hKwvA2DN5o7RqiO1CVX8EN/F/gkCjkUMgVn6hzScpwnJtl2mPR6I9XV1oW8k9O+0A==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.19.9.tgz", + "integrity": "sha512-GThgZPAwOBOsheA2RUlW5UeroRfESwMq/guy8uEe3wJlAOjpOXuSevLRd70NZ37ZrpO6RHGHgEHvPg1h3S1Jug==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.19.9.tgz", + "integrity": "sha512-Ki6PlzppaFVbLnD8PtlVQfsYw4S9n3eQl87cqgeIw+O3sRr9IghpfSKY62mggdt1yCSZ8QWvTZ9jo9fjDSg9uw==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.19.9.tgz", + "integrity": "sha512-MLHj7k9hWh4y1ddkBpvRj2b9NCBhfgBt3VpWbHQnXRedVun/hC7sIyTGDGTfsGuXo4ebik2+3ShjcPbhtFwWDw==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.19.9.tgz", + "integrity": "sha512-GQoa6OrQ8G08guMFgeXPH7yE/8Dt0IfOGWJSfSH4uafwdC7rWwrfE6P9N8AtPGIjUzdo2+7bN8Xo3qC578olhg==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.19.9.tgz", + "integrity": "sha512-UOozV7Ntykvr5tSOlGCrqU3NBr3d8JqPes0QWN2WOXfvkWVGRajC+Ym0/Wj88fUgecUCLDdJPDF0Nna2UK3Qtg==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.19.9.tgz", + "integrity": "sha512-oxoQgglOP7RH6iasDrhY+R/3cHrfwIDvRlT4CGChflq6twk8iENeVvMJjmvBb94Ik1Z+93iGO27err7w6l54GQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, "node_modules/@eslint/eslintrc": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.2.1.tgz", @@ -3680,24 +4016,33 @@ } }, "node_modules/@microsoft/api-documenter": { - "version": "7.15.3", - "integrity": "sha512-tehv1f/aKwGBQp0sheQofz5NQfa61mvTdAe4IHQnVavsyyK71r+P+CVXWewznPYkqFzzVXaTdrCuNGPU5Yd3mg==", + "version": "7.23.14", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.23.14.tgz", + "integrity": "sha512-D9cX3sS/6xN8SFbrR6I1ZTKvGl5UIPFZKYqTLg8YBUKJtFbUSDLrzRLWOcjxwxjnu+gCHAHyaNpG4G//CQivLw==", + "dev": true, "dependencies": { - "@microsoft/api-extractor-model": "7.15.3", - "@microsoft/tsdoc": "0.13.2", - "@rushstack/node-core-library": "3.45.0", - "@rushstack/ts-command-line": "4.10.6", + "@microsoft/api-extractor-model": "7.28.3", + "@microsoft/tsdoc": "0.14.2", + "@rushstack/node-core-library": "3.62.0", + "@rushstack/ts-command-line": "4.17.1", "colors": "~1.2.1", "js-yaml": "~3.13.1", - "resolve": "~1.17.0" + "resolve": "~1.22.1" }, "bin": { "api-documenter": "bin/api-documenter" } }, + "node_modules/@microsoft/api-documenter/node_modules/@microsoft/tsdoc": { + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz", + "integrity": "sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug==", + "dev": true + }, "node_modules/@microsoft/api-documenter/node_modules/js-yaml": { "version": "3.13.1", "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dev": true, "dependencies": { "argparse": "^1.0.7", "esprima": "^4.0.0" @@ -3706,50 +4051,96 @@ "js-yaml": "bin/js-yaml.js" } }, - "node_modules/@microsoft/api-documenter/node_modules/resolve": { - "version": "1.17.0", - "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", - "dependencies": { - "path-parse": "^1.0.6" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/@microsoft/api-extractor": { - "version": "7.19.4", - "integrity": "sha512-iehC6YA3DGJvxTUaK7HUtQmP6hAQU07+Q/OR8TG4dVR6KpqCi9UPEVk8AgCvQkiK+6FbVEFQTx0qLuYk4EeuHg==", + "version": "7.38.5", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.38.5.tgz", + "integrity": "sha512-c/w2zfqBcBJxaCzpJNvFoouWewcYrUOfeu5ZkWCCIXTF9a/gXM85RGevEzlMAIEGM/kssAAZSXRJIZ3Q5vLFow==", + "dev": true, "dependencies": { - "@microsoft/api-extractor-model": "7.15.3", - "@microsoft/tsdoc": "0.13.2", - "@microsoft/tsdoc-config": "~0.15.2", - "@rushstack/node-core-library": "3.45.0", - "@rushstack/rig-package": "0.3.7", - "@rushstack/ts-command-line": "4.10.6", + "@microsoft/api-extractor-model": "7.28.3", + "@microsoft/tsdoc": "0.14.2", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "3.62.0", + "@rushstack/rig-package": "0.5.1", + "@rushstack/ts-command-line": "4.17.1", "colors": "~1.2.1", "lodash": "~4.17.15", - "resolve": "~1.17.0", - "semver": "~7.3.0", + "resolve": "~1.22.1", + "semver": "~7.5.4", "source-map": "~0.6.1", - "typescript": "~4.5.2" + "typescript": "~5.0.4" }, "bin": { "api-extractor": "bin/api-extractor" } }, "node_modules/@microsoft/api-extractor-model": { - "version": "7.15.3", - "integrity": "sha512-NkSjolmSI7NGvbdz0Y7kjQfdpD+j9E5CwXTxEyjDqxd10MI7GXV8DnAsQ57GFJcgHKgTjf2aUnYfMJ9w3aMicw==", + "version": "7.28.3", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.28.3.tgz", + "integrity": "sha512-wT/kB2oDbdZXITyDh2SQLzaWwTOFbV326fP0pUwNW00WeliARs0qjmXBWmGWardEzp2U3/axkO3Lboqun6vrig==", + "dev": true, "dependencies": { - "@microsoft/tsdoc": "0.13.2", - "@microsoft/tsdoc-config": "~0.15.2", - "@rushstack/node-core-library": "3.45.0" + "@microsoft/tsdoc": "0.14.2", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "3.62.0" + } + }, + "node_modules/@microsoft/api-extractor-model/node_modules/@microsoft/tsdoc": { + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz", + "integrity": "sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug==", + "dev": true + }, + "node_modules/@microsoft/api-extractor-model/node_modules/@microsoft/tsdoc-config": { + "version": "0.16.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.16.2.tgz", + "integrity": "sha512-OGiIzzoBLgWWR0UdRJX98oYO+XKGf7tiK4Zk6tQ/E4IJqGCe7dvkTvgDZV5cFJUzLGDOjeAXrnZoA6QkVySuxw==", + "dev": true, + "dependencies": { + "@microsoft/tsdoc": "0.14.2", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" } }, - "node_modules/@microsoft/api-extractor/node_modules/resolve": { - "version": "1.17.0", - "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "node_modules/@microsoft/api-extractor-model/node_modules/resolve": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", + "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "dev": true, "dependencies": { + "is-core-module": "^2.1.0", + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/@microsoft/tsdoc": { + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz", + "integrity": "sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug==", + "dev": true + }, + "node_modules/@microsoft/api-extractor/node_modules/@microsoft/tsdoc-config": { + "version": "0.16.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.16.2.tgz", + "integrity": "sha512-OGiIzzoBLgWWR0UdRJX98oYO+XKGf7tiK4Zk6tQ/E4IJqGCe7dvkTvgDZV5cFJUzLGDOjeAXrnZoA6QkVySuxw==", + "dev": true, + "dependencies": { + "@microsoft/tsdoc": "0.14.2", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/@microsoft/tsdoc-config/node_modules/resolve": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", + "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "dev": true, + "dependencies": { + "is-core-module": "^2.1.0", "path-parse": "^1.0.6" }, "funding": { @@ -3757,8 +4148,10 @@ } }, "node_modules/@microsoft/api-extractor/node_modules/semver": { - "version": "7.3.5", - "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "version": "7.5.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", + "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", + "dev": true, "dependencies": { "lru-cache": "^6.0.0" }, @@ -3772,29 +4165,35 @@ "node_modules/@microsoft/api-extractor/node_modules/source-map": { "version": "0.6.1", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, "engines": { "node": ">=0.10.0" } }, "node_modules/@microsoft/api-extractor/node_modules/typescript": { - "version": "4.5.5", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", - "integrity": "sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==", + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.0.4.tgz", + "integrity": "sha512-cW9T5W9xY37cc+jfEnaUvX91foxtHkza3Nw3wkoF4sSlKn0MONdkdEndig/qPBWXNkmplh3NzayQzCiHM4/hqw==", + "dev": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" }, "engines": { - "node": ">=4.2.0" + "node": ">=12.20" } }, "node_modules/@microsoft/tsdoc": { "version": "0.13.2", - "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==" + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==", + "dev": true, + "peer": true }, "node_modules/@microsoft/tsdoc-config": { "version": "0.15.2", "integrity": "sha512-mK19b2wJHSdNf8znXSMYVShAHktVr/ib0Ck2FA3lsVBSEhSI/TfXT7DJQkAYgcztTuwazGcg58ZjYdk0hTCVrA==", + "dev": true, + "peer": true, "dependencies": { "@microsoft/tsdoc": "0.13.2", "ajv": "~6.12.6", @@ -3805,6 +4204,8 @@ "node_modules/@microsoft/tsdoc-config/node_modules/resolve": { "version": "1.19.0", "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "dev": true, + "peer": true, "dependencies": { "is-core-module": "^2.1.0", "path-parse": "^1.0.6" @@ -4763,6 +5164,175 @@ "react-dom": ">=16.14.0" } }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.9.0.tgz", + "integrity": "sha512-+1ge/xmaJpm1KVBuIH38Z94zj9fBD+hp+/5WLaHgyY8XLq1ibxk/zj6dTXaqM2cAbYKq8jYlhHd6k05If1W5xA==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.9.0.tgz", + "integrity": "sha512-im6hUEyQ7ZfoZdNvtwgEJvBWZYauC9KVKq1w58LG2Zfz6zMd8gRrbN+xCVoqA2hv/v6fm9lp5LFGJ3za8EQH3A==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.9.0.tgz", + "integrity": "sha512-u7aTMskN6Dmg1lCT0QJ+tINRt+ntUrvVkhbPfFz4bCwRZvjItx2nJtwJnJRlKMMaQCHRjrNqHRDYvE4mBm3DlQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.9.0.tgz", + "integrity": "sha512-8FvEl3w2ExmpcOmX5RJD0yqXcVSOqAJJUJ29Lca29Ik+3zPS1yFimr2fr5JSZ4Z5gt8/d7WqycpgkX9nocijSw==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.9.0.tgz", + "integrity": "sha512-lHoKYaRwd4gge+IpqJHCY+8Vc3hhdJfU6ukFnnrJasEBUvVlydP8PuwndbWfGkdgSvZhHfSEw6urrlBj0TSSfg==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.9.0.tgz", + "integrity": "sha512-JbEPfhndYeWHfOSeh4DOFvNXrj7ls9S/2omijVsao+LBPTPayT1uKcK3dHW3MwDJ7KO11t9m2cVTqXnTKpeaiw==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.9.0.tgz", + "integrity": "sha512-ahqcSXLlcV2XUBM3/f/C6cRoh7NxYA/W7Yzuv4bDU1YscTFw7ay4LmD7l6OS8EMhTNvcrWGkEettL1Bhjf+B+w==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.9.0.tgz", + "integrity": "sha512-uwvOYNtLw8gVtrExKhdFsYHA/kotURUmZYlinH2VcQxNCQJeJXnkmWgw2hI9Xgzhgu7J9QvWiq9TtTVwWMDa+w==", + "cpu": [ + "riscv64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.9.0.tgz", + "integrity": "sha512-m6pkSwcZZD2LCFHZX/zW2aLIISyzWLU3hrLLzQKMI12+OLEzgruTovAxY5sCZJkipklaZqPy/2bEEBNjp+Y7xg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.9.0.tgz", + "integrity": "sha512-VFAC1RDRSbU3iOF98X42KaVicAfKf0m0OvIu8dbnqhTe26Kh6Ym9JrDulz7Hbk7/9zGc41JkV02g+p3BivOdAg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.9.0.tgz", + "integrity": "sha512-9jPgMvTKXARz4inw6jezMLA2ihDBvgIU9Ml01hjdVpOcMKyxFBJrn83KVQINnbeqDv0+HdO1c09hgZ8N0s820Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.9.0.tgz", + "integrity": "sha512-WE4pT2kTXQN2bAv40Uog0AsV7/s9nT9HBWXAou8+++MBCnY51QS02KYtm6dQxxosKi1VIz/wZIrTQO5UP2EW+Q==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.9.0.tgz", + "integrity": "sha512-aPP5Q5AqNGuT0tnuEkK/g4mnt3ZhheiXrDIiSVIHN9mcN21OyXDVbEMqmXPE7e2OplNLDkcvV+ZoGJa2ZImFgw==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ] + }, "node_modules/@rushstack/eslint-patch": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/@rushstack/eslint-patch/-/eslint-patch-1.1.3.tgz", @@ -4770,37 +5340,33 @@ "dev": true }, "node_modules/@rushstack/node-core-library": { - "version": "3.45.0", - "integrity": "sha512-YMuIJl19vQT1+g/OU9mLY6T5ZBT9uDlmeXExDQACpGuxTJW+LHNbk/lRX+eCApQI2eLBlaL4U68r3kZlqwbdmw==", + "version": "3.62.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.62.0.tgz", + "integrity": "sha512-88aJn2h8UpSvdwuDXBv1/v1heM6GnBf3RjEy6ZPP7UnzHNCqOHA2Ut+ScYUbXcqIdfew9JlTAe3g+cnX9xQ/Aw==", + "dev": true, "dependencies": { - "@types/node": "12.20.24", "colors": "~1.2.1", "fs-extra": "~7.0.1", "import-lazy": "~4.0.0", "jju": "~1.4.0", - "resolve": "~1.17.0", - "semver": "~7.3.0", - "timsort": "~0.3.0", + "resolve": "~1.22.1", + "semver": "~7.5.4", "z-schema": "~5.0.2" - } - }, - "node_modules/@rushstack/node-core-library/node_modules/@types/node": { - "version": "12.20.24", - "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==" - }, - "node_modules/@rushstack/node-core-library/node_modules/resolve": { - "version": "1.17.0", - "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", - "dependencies": { - "path-parse": "^1.0.6" }, - "funding": { - "url": "https://github.com/sponsors/ljharb" + "peerDependencies": { + "@types/node": "*" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + } } }, "node_modules/@rushstack/node-core-library/node_modules/semver": { - "version": "7.3.5", - "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "version": "7.5.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", + "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", + "dev": true, "dependencies": { "lru-cache": "^6.0.0" }, @@ -4812,26 +5378,20 @@ } }, "node_modules/@rushstack/rig-package": { - "version": "0.3.7", - "integrity": "sha512-pzMsTSeTC8IiZ6EJLr53gGMvhT4oLWH+hxD7907cHyWuIUlEXFtu/2pK25vUQT13nKp5DJCWxXyYoGRk/h6rtA==", + "version": "0.5.1", + "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.5.1.tgz", + "integrity": "sha512-pXRYSe29TjRw7rqxD4WS3HN/sRSbfr+tJs4a9uuaSIBAITbUggygdhuG0VrO0EO+QqH91GhYMN4S6KRtOEmGVA==", + "dev": true, "dependencies": { - "resolve": "~1.17.0", + "resolve": "~1.22.1", "strip-json-comments": "~3.1.1" } }, - "node_modules/@rushstack/rig-package/node_modules/resolve": { - "version": "1.17.0", - "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", - "dependencies": { - "path-parse": "^1.0.6" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/@rushstack/ts-command-line": { - "version": "4.10.6", - "integrity": "sha512-Y3GkUag39sTIlukDg9mUp8MCHrrlJ27POrBNRQGc/uF+VVgX8M7zMzHch5zP6O1QVquWgD7Engdpn2piPYaS/g==", + "version": "4.17.1", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.17.1.tgz", + "integrity": "sha512-2jweO1O57BYP5qdBGl6apJLB+aRIn5ccIRTPDyULh0KMwVzFqWtw6IZWt1qtUoZD/pD2RNkIOosH6Cq45rIYeg==", + "dev": true, "dependencies": { "@types/argparse": "1.0.38", "argparse": "~1.0.9", @@ -7781,7 +8341,8 @@ }, "node_modules/@types/argparse": { "version": "1.0.38", - "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==" + "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==", + "dev": true }, "node_modules/@types/aria-query": { "version": "4.2.2", @@ -8980,6 +9541,7 @@ "node_modules/ajv": { "version": "6.12.6", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -9141,6 +9703,7 @@ "node_modules/argparse": { "version": "1.0.10", "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, "dependencies": { "sprintf-js": "~1.0.2" } @@ -10582,6 +11145,7 @@ "node_modules/colors": { "version": "1.2.5", "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "dev": true, "engines": { "node": ">=0.1.90" } @@ -10601,7 +11165,7 @@ "node_modules/commander": { "version": "2.20.3", "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", - "devOptional": true + "dev": true }, "node_modules/common-path-prefix": { "version": "3.0.0", @@ -12031,6 +12595,342 @@ "esbuild": ">=0.12 <1" } }, + "node_modules/esbuild/node_modules/@esbuild/android-arm": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.18.20.tgz", + "integrity": "sha512-fyi7TDI/ijKKNZTUJAQqiG5T7YjJXgnzkURqmGj13C6dCqckZBLdl4h7bkhHt/t0WP+zO9/zwroDvANaOqO5Sw==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/android-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.18.20.tgz", + "integrity": "sha512-Nz4rJcchGDtENV0eMKUNa6L12zz2zBDXuhj/Vjh18zGqB44Bi7MBMSXjgunJgjRhCmKOjnPuZp4Mb6OKqtMHLQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/android-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.18.20.tgz", + "integrity": "sha512-8GDdlePJA8D6zlZYJV/jnrRAi6rOiNaCC/JclcXpB+KIuvfBN4owLtgzY2bsxnx666XjJx2kDPUmnTtR8qKQUg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/darwin-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.18.20.tgz", + "integrity": "sha512-pc5gxlMDxzm513qPGbCbDukOdsGtKhfxD1zJKXjCCcU7ju50O7MeAZ8c4krSJcOIJGFR+qx21yMMVYwiQvyTyQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/freebsd-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.18.20.tgz", + "integrity": "sha512-yqDQHy4QHevpMAaxhhIwYPMv1NECwOvIpGCZkECn8w2WFHXjEwrBn3CeNIYsibZ/iZEUemj++M26W3cNR5h+Tw==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/freebsd-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.18.20.tgz", + "integrity": "sha512-tgWRPPuQsd3RmBZwarGVHZQvtzfEBOreNuxEMKFcd5DaDn2PbBxfwLcj4+aenoh7ctXcbXmOQIn8HI6mCSw5MQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/linux-arm": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.18.20.tgz", + "integrity": "sha512-/5bHkMWnq1EgKr1V+Ybz3s1hWXok7mDFUMQ4cG10AfW3wL02PSZi5kFpYKrptDsgb2WAJIvRcDm+qIvXf/apvg==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/linux-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.18.20.tgz", + "integrity": "sha512-2YbscF+UL7SQAVIpnWvYwM+3LskyDmPhe31pE7/aoTMFKKzIc9lLbyGUpmmb8a8AixOL61sQ/mFh3jEjHYFvdA==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/linux-ia32": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.18.20.tgz", + "integrity": "sha512-P4etWwq6IsReT0E1KHU40bOnzMHoH73aXp96Fs8TIT6z9Hu8G6+0SHSw9i2isWrD2nbx2qo5yUqACgdfVGx7TA==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/linux-loong64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.18.20.tgz", + "integrity": "sha512-nXW8nqBTrOpDLPgPY9uV+/1DjxoQ7DoB2N8eocyq8I9XuqJ7BiAMDMf9n1xZM9TgW0J8zrquIb/A7s3BJv7rjg==", + "cpu": [ + "loong64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/linux-mips64el": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.18.20.tgz", + "integrity": "sha512-d5NeaXZcHp8PzYy5VnXV3VSd2D328Zb+9dEq5HE6bw6+N86JVPExrA6O68OPwobntbNJ0pzCpUFZTo3w0GyetQ==", + "cpu": [ + "mips64el" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/linux-ppc64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.18.20.tgz", + "integrity": "sha512-WHPyeScRNcmANnLQkq6AfyXRFr5D6N2sKgkFo2FqguP44Nw2eyDlbTdZwd9GYk98DZG9QItIiTlFLHJHjxP3FA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/linux-riscv64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.18.20.tgz", + "integrity": "sha512-WSxo6h5ecI5XH34KC7w5veNnKkju3zBRLEQNY7mv5mtBmrP/MjNBCAlsM2u5hDBlS3NGcTQpoBvRzqBcRtpq1A==", + "cpu": [ + "riscv64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/linux-s390x": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.18.20.tgz", + "integrity": "sha512-+8231GMs3mAEth6Ja1iK0a1sQ3ohfcpzpRLH8uuc5/KVDFneH6jtAJLFGafpzpMRO6DzJ6AvXKze9LfFMrIHVQ==", + "cpu": [ + "s390x" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/linux-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.18.20.tgz", + "integrity": "sha512-UYqiqemphJcNsFEskc73jQ7B9jgwjWrSayxawS6UVFZGWrAAtkzjxSqnoclCXxWtfwLdzU+vTpcNYhpn43uP1w==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/netbsd-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.18.20.tgz", + "integrity": "sha512-iO1c++VP6xUBUmltHZoMtCUdPlnPGdBom6IrO4gyKPFFVBKioIImVooR5I83nTew5UOYrk3gIJhbZh8X44y06A==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/openbsd-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.18.20.tgz", + "integrity": "sha512-e5e4YSsuQfX4cxcygw/UCPIEP6wbIL+se3sxPdCiMbFLBWu0eiZOJ7WoD+ptCLrmjZBK1Wk7I6D/I3NglUGOxg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/sunos-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.18.20.tgz", + "integrity": "sha512-kDbFRFp0YpTQVVrqUd5FTYmWo45zGaXe0X8E1G/LKFC0v8x0vWrhOWSLITcCn63lmZIxfOMXtCfti/RxN/0wnQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/win32-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.18.20.tgz", + "integrity": "sha512-ddYFR6ItYgoaq4v4JmQQaAI5s7npztfV4Ag6NrhiaW0RrnOXqBkgwZLofVTlq1daVTQNhtI5oieTvkRPfZrePg==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/win32-ia32": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.18.20.tgz", + "integrity": "sha512-Wv7QBi3ID/rROT08SABTS7eV4hX26sVduqDOTe1MvGMjNd3EjOz4b7zeexIR62GTIEKrfJXKL9LFxTYgkyeu7g==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/esbuild/node_modules/@esbuild/win32-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.18.20.tgz", + "integrity": "sha512-kTdfRcSiDfQca/y9QIkng02avJ+NCaQvrMejlsB3RRv5sE9rRoeBPISaZpKxHELzRxZyLvNts1P27W3wV+8geQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, "node_modules/escalade": { "version": "3.1.1", "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==", @@ -12794,6 +13694,7 @@ "node_modules/esprima": { "version": "4.0.1", "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true, "bin": { "esparse": "bin/esparse.js", "esvalidate": "bin/esvalidate.js" @@ -13081,7 +13982,8 @@ }, "node_modules/fast-deep-equal": { "version": "3.1.3", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true }, "node_modules/fast-glob": { "version": "3.2.11", @@ -13105,7 +14007,8 @@ }, "node_modules/fast-json-stable-stringify": { "version": "2.1.0", - "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==" + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true }, "node_modules/fast-levenshtein": { "version": "2.0.6", @@ -13718,6 +14621,7 @@ "node_modules/fs-extra": { "version": "7.0.1", "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "dev": true, "dependencies": { "graceful-fs": "^4.1.2", "jsonfile": "^4.0.0", @@ -14310,7 +15214,8 @@ }, "node_modules/graceful-fs": { "version": "4.2.9", - "integrity": "sha512-NtNxqUcXgpW2iMrfqSfR73Glt39K+BLwWsPs94yR63v45T0Wbej7eRmL5cWfwEgqXnmjQp3zaJTshdRW/qC2ZQ==" + "integrity": "sha512-NtNxqUcXgpW2iMrfqSfR73Glt39K+BLwWsPs94yR63v45T0Wbej7eRmL5cWfwEgqXnmjQp3zaJTshdRW/qC2ZQ==", + "dev": true }, "node_modules/graphql": { "version": "15.8.0", @@ -14766,6 +15671,7 @@ "node_modules/import-lazy": { "version": "4.0.0", "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "dev": true, "engines": { "node": ">=8" } @@ -18239,7 +19145,8 @@ }, "node_modules/jju": { "version": "1.4.0", - "integrity": "sha1-o6vicYryQaKykE+EpiWXDzia4yo=" + "integrity": "sha1-o6vicYryQaKykE+EpiWXDzia4yo=", + "dev": true }, "node_modules/joi": { "version": "17.11.0", @@ -18542,7 +19449,8 @@ }, "node_modules/json-schema-traverse": { "version": "0.4.1", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true }, "node_modules/json-stable-stringify-without-jsonify": { "version": "1.0.1", @@ -18570,6 +19478,7 @@ "node_modules/jsonfile": { "version": "4.0.0", "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", + "dev": true, "optionalDependencies": { "graceful-fs": "^4.1.6" } @@ -18795,11 +19704,13 @@ }, "node_modules/lodash.get": { "version": "4.4.2", - "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=" + "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", + "dev": true }, "node_modules/lodash.isequal": { "version": "4.5.0", - "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA=" + "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA=", + "dev": true }, "node_modules/lodash.memoize": { "version": "4.1.2", @@ -18925,6 +19836,7 @@ "node_modules/lru-cache": { "version": "6.0.0", "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, "dependencies": { "yallist": "^4.0.0" }, @@ -20848,6 +21760,7 @@ "node_modules/punycode": { "version": "2.1.1", "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", + "dev": true, "engines": { "node": ">=6" } @@ -21943,18 +22856,31 @@ } }, "node_modules/rollup": { - "version": "3.29.2", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-3.29.2.tgz", - "integrity": "sha512-CJouHoZ27v6siztc21eEQGo0kIcE5D1gVPA571ez0mMYb25LGYGKnVNXpEj5MGlepmDWGXNjDB5q7uNiPHC11A==", + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.9.0.tgz", + "integrity": "sha512-bUHW/9N21z64gw8s6tP4c88P382Bq/L5uZDowHlHx6s/QWpjJXivIAbEw6LZthgSvlEizZBfLC4OAvWe7aoF7A==", "dev": true, "bin": { "rollup": "dist/bin/rollup" }, "engines": { - "node": ">=14.18.0", + "node": ">=18.0.0", "npm": ">=8.0.0" }, "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.9.0", + "@rollup/rollup-android-arm64": "4.9.0", + "@rollup/rollup-darwin-arm64": "4.9.0", + "@rollup/rollup-darwin-x64": "4.9.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.9.0", + "@rollup/rollup-linux-arm64-gnu": "4.9.0", + "@rollup/rollup-linux-arm64-musl": "4.9.0", + "@rollup/rollup-linux-riscv64-gnu": "4.9.0", + "@rollup/rollup-linux-x64-gnu": "4.9.0", + "@rollup/rollup-linux-x64-musl": "4.9.0", + "@rollup/rollup-win32-arm64-msvc": "4.9.0", + "@rollup/rollup-win32-ia32-msvc": "4.9.0", + "@rollup/rollup-win32-x64-msvc": "4.9.0", "fsevents": "~2.3.2" } }, @@ -22442,7 +23368,8 @@ }, "node_modules/sprintf-js": { "version": "1.0.3", - "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=" + "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", + "dev": true }, "node_modules/ssim.js": { "version": "3.5.0", @@ -22564,6 +23491,7 @@ "node_modules/string-argv": { "version": "0.3.1", "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "dev": true, "engines": { "node": ">=0.6.19" } @@ -22718,6 +23646,7 @@ "node_modules/strip-json-comments": { "version": "3.1.1", "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, "engines": { "node": ">=8" }, @@ -23262,10 +24191,6 @@ "safe-buffer": "~5.1.0" } }, - "node_modules/timsort": { - "version": "0.3.0", - "integrity": "sha1-QFQRqOfmM5/mTbmiNN4R3DHgK9Q=" - }, "node_modules/tiny-invariant": { "version": "1.3.1", "resolved": "https://registry.npmjs.org/tiny-invariant/-/tiny-invariant-1.3.1.tgz", @@ -23503,22 +24428,22 @@ "dev": true }, "node_modules/tsup": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/tsup/-/tsup-7.2.0.tgz", - "integrity": "sha512-vDHlczXbgUvY3rWvqFEbSqmC1L7woozbzngMqTtL2PGBODTtWlRwGDDawhvWzr5c1QjKe4OAKqJGfE1xeXUvtQ==", + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/tsup/-/tsup-8.0.1.tgz", + "integrity": "sha512-hvW7gUSG96j53ZTSlT4j/KL0q1Q2l6TqGBFc6/mu/L46IoNWqLLUzLRLP1R8Q7xrJTmkDxxDoojV5uCVs1sVOg==", "dev": true, "dependencies": { "bundle-require": "^4.0.0", "cac": "^6.7.12", "chokidar": "^3.5.1", "debug": "^4.3.1", - "esbuild": "^0.18.2", + "esbuild": "^0.19.2", "execa": "^5.0.0", "globby": "^11.0.3", "joycon": "^3.0.1", "postcss-load-config": "^4.0.1", "resolve-from": "^5.0.0", - "rollup": "^3.2.5", + "rollup": "^4.0.2", "source-map": "0.8.0-beta.0", "sucrase": "^3.20.3", "tree-kill": "^1.2.2" @@ -23528,14 +24453,18 @@ "tsup-node": "dist/cli-node.js" }, "engines": { - "node": ">=16.14" + "node": ">=18" }, "peerDependencies": { + "@microsoft/api-extractor": "^7.36.0", "@swc/core": "^1", "postcss": "^8.4.12", - "typescript": ">=4.1.0" + "typescript": ">=4.5.0" }, "peerDependenciesMeta": { + "@microsoft/api-extractor": { + "optional": true + }, "@swc/core": { "optional": true }, @@ -23547,6 +24476,59 @@ } } }, + "node_modules/tsup/node_modules/@esbuild/darwin-arm64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.19.9.tgz", + "integrity": "sha512-KBJ9S0AFyLVx2E5D8W0vExqRW01WqRtczUZ8NRu+Pi+87opZn5tL4Y0xT0mA4FtHctd0ZgwNoN639fUUGlNIWw==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/tsup/node_modules/esbuild": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.19.9.tgz", + "integrity": "sha512-U9CHtKSy+EpPsEBa+/A2gMs/h3ylBC0H0KSqIg7tpztHerLi6nrrcoUJAkNCEPumx8yJ+Byic4BVwHgRbN0TBg==", + "dev": true, + "hasInstallScript": true, + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=12" + }, + "optionalDependencies": { + "@esbuild/android-arm": "0.19.9", + "@esbuild/android-arm64": "0.19.9", + "@esbuild/android-x64": "0.19.9", + "@esbuild/darwin-arm64": "0.19.9", + "@esbuild/darwin-x64": "0.19.9", + "@esbuild/freebsd-arm64": "0.19.9", + "@esbuild/freebsd-x64": "0.19.9", + "@esbuild/linux-arm": "0.19.9", + "@esbuild/linux-arm64": "0.19.9", + "@esbuild/linux-ia32": "0.19.9", + "@esbuild/linux-loong64": "0.19.9", + "@esbuild/linux-mips64el": "0.19.9", + "@esbuild/linux-ppc64": "0.19.9", + "@esbuild/linux-riscv64": "0.19.9", + "@esbuild/linux-s390x": "0.19.9", + "@esbuild/linux-x64": "0.19.9", + "@esbuild/netbsd-x64": "0.19.9", + "@esbuild/openbsd-x64": "0.19.9", + "@esbuild/sunos-x64": "0.19.9", + "@esbuild/win32-arm64": "0.19.9", + "@esbuild/win32-ia32": "0.19.9", + "@esbuild/win32-x64": "0.19.9" + } + }, "node_modules/tsup/node_modules/source-map": { "version": "0.8.0-beta.0", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.8.0-beta.0.tgz", @@ -23813,6 +24795,7 @@ "node_modules/universalify": { "version": "0.1.2", "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "dev": true, "engines": { "node": ">= 4.0.0" } @@ -23892,6 +24875,7 @@ "node_modules/uri-js": { "version": "4.4.1", "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, "dependencies": { "punycode": "^2.1.0" } @@ -24094,6 +25078,7 @@ "node_modules/validator": { "version": "13.7.0", "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "dev": true, "engines": { "node": ">= 0.10" } @@ -24742,7 +25727,8 @@ }, "node_modules/yallist": { "version": "4.0.0", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==" + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true }, "node_modules/yaml": { "version": "1.10.2", @@ -24803,6 +25789,7 @@ "node_modules/z-schema": { "version": "5.0.2", "integrity": "sha512-40TH47ukMHq5HrzkeVE40Ad7eIDKaRV2b+Qpi2prLc9X9eFJFzV7tMe5aH12e6avaSS/u5l653EQOv+J9PirPw==", + "dev": true, "dependencies": { "lodash.get": "^4.4.2", "lodash.isequal": "^4.5.0", @@ -26397,6 +27384,27 @@ "dev": true, "requires": {} }, + "@esbuild/android-arm": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.19.9.tgz", + "integrity": "sha512-jkYjjq7SdsWuNI6b5quymW0oC83NN5FdRPuCbs9HZ02mfVdAP8B8eeqLSYU3gb6OJEaY5CQabtTFbqBf26H3GA==", + "dev": true, + "optional": true + }, + "@esbuild/android-arm64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.19.9.tgz", + "integrity": "sha512-q4cR+6ZD0938R19MyEW3jEsMzbb/1rulLXiNAJQADD/XYp7pT+rOS5JGxvpRW8dFDEfjW4wLgC/3FXIw4zYglQ==", + "dev": true, + "optional": true + }, + "@esbuild/android-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.19.9.tgz", + "integrity": "sha512-KOqoPntWAH6ZxDwx1D6mRntIgZh9KodzgNOy5Ebt9ghzffOk9X2c1sPwtM9P+0eXbefnDhqYfkh5PLP5ULtWFA==", + "dev": true, + "optional": true + }, "@esbuild/darwin-arm64": { "version": "0.18.20", "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.18.20.tgz", @@ -26404,6 +27412,132 @@ "dev": true, "optional": true }, + "@esbuild/darwin-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.19.9.tgz", + "integrity": "sha512-vE0VotmNTQaTdX0Q9dOHmMTao6ObjyPm58CHZr1UK7qpNleQyxlFlNCaHsHx6Uqv86VgPmR4o2wdNq3dP1qyDQ==", + "dev": true, + "optional": true + }, + "@esbuild/freebsd-arm64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.19.9.tgz", + "integrity": "sha512-uFQyd/o1IjiEk3rUHSwUKkqZwqdvuD8GevWF065eqgYfexcVkxh+IJgwTaGZVu59XczZGcN/YMh9uF1fWD8j1g==", + "dev": true, + "optional": true + }, + "@esbuild/freebsd-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.19.9.tgz", + "integrity": "sha512-WMLgWAtkdTbTu1AWacY7uoj/YtHthgqrqhf1OaEWnZb7PQgpt8eaA/F3LkV0E6K/Lc0cUr/uaVP/49iE4M4asA==", + "dev": true, + "optional": true + }, + "@esbuild/linux-arm": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.19.9.tgz", + "integrity": "sha512-C/ChPohUYoyUaqn1h17m/6yt6OB14hbXvT8EgM1ZWaiiTYz7nWZR0SYmMnB5BzQA4GXl3BgBO1l8MYqL/He3qw==", + "dev": true, + "optional": true + }, + "@esbuild/linux-arm64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.19.9.tgz", + "integrity": "sha512-PiPblfe1BjK7WDAKR1Cr9O7VVPqVNpwFcPWgfn4xu0eMemzRp442hXyzF/fSwgrufI66FpHOEJk0yYdPInsmyQ==", + "dev": true, + "optional": true + }, + "@esbuild/linux-ia32": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.19.9.tgz", + "integrity": "sha512-f37i/0zE0MjDxijkPSQw1CO/7C27Eojqb+r3BbHVxMLkj8GCa78TrBZzvPyA/FNLUMzP3eyHCVkAopkKVja+6Q==", + "dev": true, + "optional": true + }, + "@esbuild/linux-loong64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.19.9.tgz", + "integrity": "sha512-t6mN147pUIf3t6wUt3FeumoOTPfmv9Cc6DQlsVBpB7eCpLOqQDyWBP1ymXn1lDw4fNUSb/gBcKAmvTP49oIkaA==", + "dev": true, + "optional": true + }, + "@esbuild/linux-mips64el": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.19.9.tgz", + "integrity": "sha512-jg9fujJTNTQBuDXdmAg1eeJUL4Jds7BklOTkkH80ZgQIoCTdQrDaHYgbFZyeTq8zbY+axgptncko3v9p5hLZtw==", + "dev": true, + "optional": true + }, + "@esbuild/linux-ppc64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.19.9.tgz", + "integrity": "sha512-tkV0xUX0pUUgY4ha7z5BbDS85uI7ABw3V1d0RNTii7E9lbmV8Z37Pup2tsLV46SQWzjOeyDi1Q7Wx2+QM8WaCQ==", + "dev": true, + "optional": true + }, + "@esbuild/linux-riscv64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.19.9.tgz", + "integrity": "sha512-DfLp8dj91cufgPZDXr9p3FoR++m3ZJ6uIXsXrIvJdOjXVREtXuQCjfMfvmc3LScAVmLjcfloyVtpn43D56JFHg==", + "dev": true, + "optional": true + }, + "@esbuild/linux-s390x": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.19.9.tgz", + "integrity": "sha512-zHbglfEdC88KMgCWpOl/zc6dDYJvWGLiUtmPRsr1OgCViu3z5GncvNVdf+6/56O2Ca8jUU+t1BW261V6kp8qdw==", + "dev": true, + "optional": true + }, + "@esbuild/linux-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.19.9.tgz", + "integrity": "sha512-JUjpystGFFmNrEHQnIVG8hKwvA2DN5o7RqiO1CVX8EN/F/gkCjkUMgVn6hzScpwnJtl2mPR6I9XV1oW8k9O+0A==", + "dev": true, + "optional": true + }, + "@esbuild/netbsd-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.19.9.tgz", + "integrity": "sha512-GThgZPAwOBOsheA2RUlW5UeroRfESwMq/guy8uEe3wJlAOjpOXuSevLRd70NZ37ZrpO6RHGHgEHvPg1h3S1Jug==", + "dev": true, + "optional": true + }, + "@esbuild/openbsd-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.19.9.tgz", + "integrity": "sha512-Ki6PlzppaFVbLnD8PtlVQfsYw4S9n3eQl87cqgeIw+O3sRr9IghpfSKY62mggdt1yCSZ8QWvTZ9jo9fjDSg9uw==", + "dev": true, + "optional": true + }, + "@esbuild/sunos-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.19.9.tgz", + "integrity": "sha512-MLHj7k9hWh4y1ddkBpvRj2b9NCBhfgBt3VpWbHQnXRedVun/hC7sIyTGDGTfsGuXo4ebik2+3ShjcPbhtFwWDw==", + "dev": true, + "optional": true + }, + "@esbuild/win32-arm64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.19.9.tgz", + "integrity": "sha512-GQoa6OrQ8G08guMFgeXPH7yE/8Dt0IfOGWJSfSH4uafwdC7rWwrfE6P9N8AtPGIjUzdo2+7bN8Xo3qC578olhg==", + "dev": true, + "optional": true + }, + "@esbuild/win32-ia32": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.19.9.tgz", + "integrity": "sha512-UOozV7Ntykvr5tSOlGCrqU3NBr3d8JqPes0QWN2WOXfvkWVGRajC+Ym0/Wj88fUgecUCLDdJPDF0Nna2UK3Qtg==", + "dev": true, + "optional": true + }, + "@esbuild/win32-x64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.19.9.tgz", + "integrity": "sha512-oxoQgglOP7RH6iasDrhY+R/3cHrfwIDvRlT4CGChflq6twk8iENeVvMJjmvBb94Ik1Z+93iGO27err7w6l54GQ==", + "dev": true, + "optional": true + }, "@eslint/eslintrc": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.2.1.tgz", @@ -27433,94 +28567,161 @@ } }, "@microsoft/api-documenter": { - "version": "7.15.3", - "integrity": "sha512-tehv1f/aKwGBQp0sheQofz5NQfa61mvTdAe4IHQnVavsyyK71r+P+CVXWewznPYkqFzzVXaTdrCuNGPU5Yd3mg==", + "version": "7.23.14", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.23.14.tgz", + "integrity": "sha512-D9cX3sS/6xN8SFbrR6I1ZTKvGl5UIPFZKYqTLg8YBUKJtFbUSDLrzRLWOcjxwxjnu+gCHAHyaNpG4G//CQivLw==", + "dev": true, "requires": { - "@microsoft/api-extractor-model": "7.15.3", - "@microsoft/tsdoc": "0.13.2", - "@rushstack/node-core-library": "3.45.0", - "@rushstack/ts-command-line": "4.10.6", + "@microsoft/api-extractor-model": "7.28.3", + "@microsoft/tsdoc": "0.14.2", + "@rushstack/node-core-library": "3.62.0", + "@rushstack/ts-command-line": "4.17.1", "colors": "~1.2.1", "js-yaml": "~3.13.1", - "resolve": "~1.17.0" + "resolve": "~1.22.1" }, "dependencies": { + "@microsoft/tsdoc": { + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz", + "integrity": "sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug==", + "dev": true + }, "js-yaml": { "version": "3.13.1", "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dev": true, "requires": { "argparse": "^1.0.7", "esprima": "^4.0.0" } - }, - "resolve": { - "version": "1.17.0", - "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", - "requires": { - "path-parse": "^1.0.6" - } } } }, "@microsoft/api-extractor": { - "version": "7.19.4", - "integrity": "sha512-iehC6YA3DGJvxTUaK7HUtQmP6hAQU07+Q/OR8TG4dVR6KpqCi9UPEVk8AgCvQkiK+6FbVEFQTx0qLuYk4EeuHg==", + "version": "7.38.5", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.38.5.tgz", + "integrity": "sha512-c/w2zfqBcBJxaCzpJNvFoouWewcYrUOfeu5ZkWCCIXTF9a/gXM85RGevEzlMAIEGM/kssAAZSXRJIZ3Q5vLFow==", + "dev": true, "requires": { - "@microsoft/api-extractor-model": "7.15.3", - "@microsoft/tsdoc": "0.13.2", - "@microsoft/tsdoc-config": "~0.15.2", - "@rushstack/node-core-library": "3.45.0", - "@rushstack/rig-package": "0.3.7", - "@rushstack/ts-command-line": "4.10.6", + "@microsoft/api-extractor-model": "7.28.3", + "@microsoft/tsdoc": "0.14.2", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "3.62.0", + "@rushstack/rig-package": "0.5.1", + "@rushstack/ts-command-line": "4.17.1", "colors": "~1.2.1", "lodash": "~4.17.15", - "resolve": "~1.17.0", - "semver": "~7.3.0", + "resolve": "~1.22.1", + "semver": "~7.5.4", "source-map": "~0.6.1", - "typescript": "~4.5.2" + "typescript": "~5.0.4" }, "dependencies": { - "resolve": { - "version": "1.17.0", - "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "@microsoft/tsdoc": { + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz", + "integrity": "sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug==", + "dev": true + }, + "@microsoft/tsdoc-config": { + "version": "0.16.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.16.2.tgz", + "integrity": "sha512-OGiIzzoBLgWWR0UdRJX98oYO+XKGf7tiK4Zk6tQ/E4IJqGCe7dvkTvgDZV5cFJUzLGDOjeAXrnZoA6QkVySuxw==", + "dev": true, "requires": { - "path-parse": "^1.0.6" + "@microsoft/tsdoc": "0.14.2", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" + }, + "dependencies": { + "resolve": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", + "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "dev": true, + "requires": { + "is-core-module": "^2.1.0", + "path-parse": "^1.0.6" + } + } } }, "semver": { - "version": "7.3.5", - "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "version": "7.5.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", + "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", + "dev": true, "requires": { "lru-cache": "^6.0.0" } }, "source-map": { "version": "0.6.1", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==" + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true }, "typescript": { - "version": "4.5.5", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", - "integrity": "sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==" + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.0.4.tgz", + "integrity": "sha512-cW9T5W9xY37cc+jfEnaUvX91foxtHkza3Nw3wkoF4sSlKn0MONdkdEndig/qPBWXNkmplh3NzayQzCiHM4/hqw==", + "dev": true } } }, "@microsoft/api-extractor-model": { - "version": "7.15.3", - "integrity": "sha512-NkSjolmSI7NGvbdz0Y7kjQfdpD+j9E5CwXTxEyjDqxd10MI7GXV8DnAsQ57GFJcgHKgTjf2aUnYfMJ9w3aMicw==", + "version": "7.28.3", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.28.3.tgz", + "integrity": "sha512-wT/kB2oDbdZXITyDh2SQLzaWwTOFbV326fP0pUwNW00WeliARs0qjmXBWmGWardEzp2U3/axkO3Lboqun6vrig==", + "dev": true, "requires": { - "@microsoft/tsdoc": "0.13.2", - "@microsoft/tsdoc-config": "~0.15.2", - "@rushstack/node-core-library": "3.45.0" + "@microsoft/tsdoc": "0.14.2", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "3.62.0" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz", + "integrity": "sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug==", + "dev": true + }, + "@microsoft/tsdoc-config": { + "version": "0.16.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.16.2.tgz", + "integrity": "sha512-OGiIzzoBLgWWR0UdRJX98oYO+XKGf7tiK4Zk6tQ/E4IJqGCe7dvkTvgDZV5cFJUzLGDOjeAXrnZoA6QkVySuxw==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.14.2", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" + } + }, + "resolve": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", + "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "dev": true, + "requires": { + "is-core-module": "^2.1.0", + "path-parse": "^1.0.6" + } + } } }, "@microsoft/tsdoc": { "version": "0.13.2", - "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==" + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==", + "dev": true, + "peer": true }, "@microsoft/tsdoc-config": { "version": "0.15.2", "integrity": "sha512-mK19b2wJHSdNf8znXSMYVShAHktVr/ib0Ck2FA3lsVBSEhSI/TfXT7DJQkAYgcztTuwazGcg58ZjYdk0hTCVrA==", + "dev": true, + "peer": true, "requires": { "@microsoft/tsdoc": "0.13.2", "ajv": "~6.12.6", @@ -27531,6 +28732,8 @@ "resolve": { "version": "1.19.0", "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "dev": true, + "peer": true, "requires": { "is-core-module": "^2.1.0", "path-parse": "^1.0.6" @@ -28074,6 +29277,97 @@ "warning": "^4.0.3" } }, + "@rollup/rollup-android-arm-eabi": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.9.0.tgz", + "integrity": "sha512-+1ge/xmaJpm1KVBuIH38Z94zj9fBD+hp+/5WLaHgyY8XLq1ibxk/zj6dTXaqM2cAbYKq8jYlhHd6k05If1W5xA==", + "dev": true, + "optional": true + }, + "@rollup/rollup-android-arm64": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.9.0.tgz", + "integrity": "sha512-im6hUEyQ7ZfoZdNvtwgEJvBWZYauC9KVKq1w58LG2Zfz6zMd8gRrbN+xCVoqA2hv/v6fm9lp5LFGJ3za8EQH3A==", + "dev": true, + "optional": true + }, + "@rollup/rollup-darwin-arm64": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.9.0.tgz", + "integrity": "sha512-u7aTMskN6Dmg1lCT0QJ+tINRt+ntUrvVkhbPfFz4bCwRZvjItx2nJtwJnJRlKMMaQCHRjrNqHRDYvE4mBm3DlQ==", + "dev": true, + "optional": true + }, + "@rollup/rollup-darwin-x64": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.9.0.tgz", + "integrity": "sha512-8FvEl3w2ExmpcOmX5RJD0yqXcVSOqAJJUJ29Lca29Ik+3zPS1yFimr2fr5JSZ4Z5gt8/d7WqycpgkX9nocijSw==", + "dev": true, + "optional": true + }, + "@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.9.0.tgz", + "integrity": "sha512-lHoKYaRwd4gge+IpqJHCY+8Vc3hhdJfU6ukFnnrJasEBUvVlydP8PuwndbWfGkdgSvZhHfSEw6urrlBj0TSSfg==", + "dev": true, + "optional": true + }, + "@rollup/rollup-linux-arm64-gnu": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.9.0.tgz", + "integrity": "sha512-JbEPfhndYeWHfOSeh4DOFvNXrj7ls9S/2omijVsao+LBPTPayT1uKcK3dHW3MwDJ7KO11t9m2cVTqXnTKpeaiw==", + "dev": true, + "optional": true + }, + "@rollup/rollup-linux-arm64-musl": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.9.0.tgz", + "integrity": "sha512-ahqcSXLlcV2XUBM3/f/C6cRoh7NxYA/W7Yzuv4bDU1YscTFw7ay4LmD7l6OS8EMhTNvcrWGkEettL1Bhjf+B+w==", + "dev": true, + "optional": true + }, + "@rollup/rollup-linux-riscv64-gnu": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.9.0.tgz", + "integrity": "sha512-uwvOYNtLw8gVtrExKhdFsYHA/kotURUmZYlinH2VcQxNCQJeJXnkmWgw2hI9Xgzhgu7J9QvWiq9TtTVwWMDa+w==", + "dev": true, + "optional": true + }, + "@rollup/rollup-linux-x64-gnu": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.9.0.tgz", + "integrity": "sha512-m6pkSwcZZD2LCFHZX/zW2aLIISyzWLU3hrLLzQKMI12+OLEzgruTovAxY5sCZJkipklaZqPy/2bEEBNjp+Y7xg==", + "dev": true, + "optional": true + }, + "@rollup/rollup-linux-x64-musl": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.9.0.tgz", + "integrity": "sha512-VFAC1RDRSbU3iOF98X42KaVicAfKf0m0OvIu8dbnqhTe26Kh6Ym9JrDulz7Hbk7/9zGc41JkV02g+p3BivOdAg==", + "dev": true, + "optional": true + }, + "@rollup/rollup-win32-arm64-msvc": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.9.0.tgz", + "integrity": "sha512-9jPgMvTKXARz4inw6jezMLA2ihDBvgIU9Ml01hjdVpOcMKyxFBJrn83KVQINnbeqDv0+HdO1c09hgZ8N0s820Q==", + "dev": true, + "optional": true + }, + "@rollup/rollup-win32-ia32-msvc": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.9.0.tgz", + "integrity": "sha512-WE4pT2kTXQN2bAv40Uog0AsV7/s9nT9HBWXAou8+++MBCnY51QS02KYtm6dQxxosKi1VIz/wZIrTQO5UP2EW+Q==", + "dev": true, + "optional": true + }, + "@rollup/rollup-win32-x64-msvc": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.9.0.tgz", + "integrity": "sha512-aPP5Q5AqNGuT0tnuEkK/g4mnt3ZhheiXrDIiSVIHN9mcN21OyXDVbEMqmXPE7e2OplNLDkcvV+ZoGJa2ZImFgw==", + "dev": true, + "optional": true + }, "@rushstack/eslint-patch": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/@rushstack/eslint-patch/-/eslint-patch-1.1.3.tgz", @@ -28081,34 +29375,25 @@ "dev": true }, "@rushstack/node-core-library": { - "version": "3.45.0", - "integrity": "sha512-YMuIJl19vQT1+g/OU9mLY6T5ZBT9uDlmeXExDQACpGuxTJW+LHNbk/lRX+eCApQI2eLBlaL4U68r3kZlqwbdmw==", + "version": "3.62.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.62.0.tgz", + "integrity": "sha512-88aJn2h8UpSvdwuDXBv1/v1heM6GnBf3RjEy6ZPP7UnzHNCqOHA2Ut+ScYUbXcqIdfew9JlTAe3g+cnX9xQ/Aw==", + "dev": true, "requires": { - "@types/node": "12.20.24", "colors": "~1.2.1", "fs-extra": "~7.0.1", "import-lazy": "~4.0.0", "jju": "~1.4.0", - "resolve": "~1.17.0", - "semver": "~7.3.0", - "timsort": "~0.3.0", + "resolve": "~1.22.1", + "semver": "~7.5.4", "z-schema": "~5.0.2" }, "dependencies": { - "@types/node": { - "version": "12.20.24", - "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==" - }, - "resolve": { - "version": "1.17.0", - "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", - "requires": { - "path-parse": "^1.0.6" - } - }, "semver": { - "version": "7.3.5", - "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "version": "7.5.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", + "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", + "dev": true, "requires": { "lru-cache": "^6.0.0" } @@ -28116,25 +29401,20 @@ } }, "@rushstack/rig-package": { - "version": "0.3.7", - "integrity": "sha512-pzMsTSeTC8IiZ6EJLr53gGMvhT4oLWH+hxD7907cHyWuIUlEXFtu/2pK25vUQT13nKp5DJCWxXyYoGRk/h6rtA==", + "version": "0.5.1", + "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.5.1.tgz", + "integrity": "sha512-pXRYSe29TjRw7rqxD4WS3HN/sRSbfr+tJs4a9uuaSIBAITbUggygdhuG0VrO0EO+QqH91GhYMN4S6KRtOEmGVA==", + "dev": true, "requires": { - "resolve": "~1.17.0", + "resolve": "~1.22.1", "strip-json-comments": "~3.1.1" - }, - "dependencies": { - "resolve": { - "version": "1.17.0", - "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", - "requires": { - "path-parse": "^1.0.6" - } - } } }, "@rushstack/ts-command-line": { - "version": "4.10.6", - "integrity": "sha512-Y3GkUag39sTIlukDg9mUp8MCHrrlJ27POrBNRQGc/uF+VVgX8M7zMzHch5zP6O1QVquWgD7Engdpn2piPYaS/g==", + "version": "4.17.1", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.17.1.tgz", + "integrity": "sha512-2jweO1O57BYP5qdBGl6apJLB+aRIn5ccIRTPDyULh0KMwVzFqWtw6IZWt1qtUoZD/pD2RNkIOosH6Cq45rIYeg==", + "dev": true, "requires": { "@types/argparse": "1.0.38", "argparse": "~1.0.9", @@ -30240,7 +31520,8 @@ }, "@types/argparse": { "version": "1.0.38", - "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==" + "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==", + "dev": true }, "@types/aria-query": { "version": "4.2.2", @@ -31259,6 +32540,7 @@ "ajv": { "version": "6.12.6", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, "requires": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -31377,6 +32659,7 @@ "argparse": { "version": "1.0.10", "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, "requires": { "sprintf-js": "~1.0.2" } @@ -32433,7 +33716,8 @@ }, "colors": { "version": "1.2.5", - "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==" + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "dev": true }, "combined-stream": { "version": "1.0.8", @@ -32447,7 +33731,7 @@ "commander": { "version": "2.20.3", "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", - "devOptional": true + "dev": true }, "common-path-prefix": { "version": "3.0.0", @@ -33567,6 +34851,155 @@ "@esbuild/win32-arm64": "0.18.20", "@esbuild/win32-ia32": "0.18.20", "@esbuild/win32-x64": "0.18.20" + }, + "dependencies": { + "@esbuild/android-arm": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.18.20.tgz", + "integrity": "sha512-fyi7TDI/ijKKNZTUJAQqiG5T7YjJXgnzkURqmGj13C6dCqckZBLdl4h7bkhHt/t0WP+zO9/zwroDvANaOqO5Sw==", + "dev": true, + "optional": true + }, + "@esbuild/android-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.18.20.tgz", + "integrity": "sha512-Nz4rJcchGDtENV0eMKUNa6L12zz2zBDXuhj/Vjh18zGqB44Bi7MBMSXjgunJgjRhCmKOjnPuZp4Mb6OKqtMHLQ==", + "dev": true, + "optional": true + }, + "@esbuild/android-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.18.20.tgz", + "integrity": "sha512-8GDdlePJA8D6zlZYJV/jnrRAi6rOiNaCC/JclcXpB+KIuvfBN4owLtgzY2bsxnx666XjJx2kDPUmnTtR8qKQUg==", + "dev": true, + "optional": true + }, + "@esbuild/darwin-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.18.20.tgz", + "integrity": "sha512-pc5gxlMDxzm513qPGbCbDukOdsGtKhfxD1zJKXjCCcU7ju50O7MeAZ8c4krSJcOIJGFR+qx21yMMVYwiQvyTyQ==", + "dev": true, + "optional": true + }, + "@esbuild/freebsd-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.18.20.tgz", + "integrity": "sha512-yqDQHy4QHevpMAaxhhIwYPMv1NECwOvIpGCZkECn8w2WFHXjEwrBn3CeNIYsibZ/iZEUemj++M26W3cNR5h+Tw==", + "dev": true, + "optional": true + }, + "@esbuild/freebsd-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.18.20.tgz", + "integrity": "sha512-tgWRPPuQsd3RmBZwarGVHZQvtzfEBOreNuxEMKFcd5DaDn2PbBxfwLcj4+aenoh7ctXcbXmOQIn8HI6mCSw5MQ==", + "dev": true, + "optional": true + }, + "@esbuild/linux-arm": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.18.20.tgz", + "integrity": "sha512-/5bHkMWnq1EgKr1V+Ybz3s1hWXok7mDFUMQ4cG10AfW3wL02PSZi5kFpYKrptDsgb2WAJIvRcDm+qIvXf/apvg==", + "dev": true, + "optional": true + }, + "@esbuild/linux-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.18.20.tgz", + "integrity": "sha512-2YbscF+UL7SQAVIpnWvYwM+3LskyDmPhe31pE7/aoTMFKKzIc9lLbyGUpmmb8a8AixOL61sQ/mFh3jEjHYFvdA==", + "dev": true, + "optional": true + }, + "@esbuild/linux-ia32": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.18.20.tgz", + "integrity": "sha512-P4etWwq6IsReT0E1KHU40bOnzMHoH73aXp96Fs8TIT6z9Hu8G6+0SHSw9i2isWrD2nbx2qo5yUqACgdfVGx7TA==", + "dev": true, + "optional": true + }, + "@esbuild/linux-loong64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.18.20.tgz", + "integrity": "sha512-nXW8nqBTrOpDLPgPY9uV+/1DjxoQ7DoB2N8eocyq8I9XuqJ7BiAMDMf9n1xZM9TgW0J8zrquIb/A7s3BJv7rjg==", + "dev": true, + "optional": true + }, + "@esbuild/linux-mips64el": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.18.20.tgz", + "integrity": "sha512-d5NeaXZcHp8PzYy5VnXV3VSd2D328Zb+9dEq5HE6bw6+N86JVPExrA6O68OPwobntbNJ0pzCpUFZTo3w0GyetQ==", + "dev": true, + "optional": true + }, + "@esbuild/linux-ppc64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.18.20.tgz", + "integrity": "sha512-WHPyeScRNcmANnLQkq6AfyXRFr5D6N2sKgkFo2FqguP44Nw2eyDlbTdZwd9GYk98DZG9QItIiTlFLHJHjxP3FA==", + "dev": true, + "optional": true + }, + "@esbuild/linux-riscv64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.18.20.tgz", + "integrity": "sha512-WSxo6h5ecI5XH34KC7w5veNnKkju3zBRLEQNY7mv5mtBmrP/MjNBCAlsM2u5hDBlS3NGcTQpoBvRzqBcRtpq1A==", + "dev": true, + "optional": true + }, + "@esbuild/linux-s390x": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.18.20.tgz", + "integrity": "sha512-+8231GMs3mAEth6Ja1iK0a1sQ3ohfcpzpRLH8uuc5/KVDFneH6jtAJLFGafpzpMRO6DzJ6AvXKze9LfFMrIHVQ==", + "dev": true, + "optional": true + }, + "@esbuild/linux-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.18.20.tgz", + "integrity": "sha512-UYqiqemphJcNsFEskc73jQ7B9jgwjWrSayxawS6UVFZGWrAAtkzjxSqnoclCXxWtfwLdzU+vTpcNYhpn43uP1w==", + "dev": true, + "optional": true + }, + "@esbuild/netbsd-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.18.20.tgz", + "integrity": "sha512-iO1c++VP6xUBUmltHZoMtCUdPlnPGdBom6IrO4gyKPFFVBKioIImVooR5I83nTew5UOYrk3gIJhbZh8X44y06A==", + "dev": true, + "optional": true + }, + "@esbuild/openbsd-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.18.20.tgz", + "integrity": "sha512-e5e4YSsuQfX4cxcygw/UCPIEP6wbIL+se3sxPdCiMbFLBWu0eiZOJ7WoD+ptCLrmjZBK1Wk7I6D/I3NglUGOxg==", + "dev": true, + "optional": true + }, + "@esbuild/sunos-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.18.20.tgz", + "integrity": "sha512-kDbFRFp0YpTQVVrqUd5FTYmWo45zGaXe0X8E1G/LKFC0v8x0vWrhOWSLITcCn63lmZIxfOMXtCfti/RxN/0wnQ==", + "dev": true, + "optional": true + }, + "@esbuild/win32-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.18.20.tgz", + "integrity": "sha512-ddYFR6ItYgoaq4v4JmQQaAI5s7npztfV4Ag6NrhiaW0RrnOXqBkgwZLofVTlq1daVTQNhtI5oieTvkRPfZrePg==", + "dev": true, + "optional": true + }, + "@esbuild/win32-ia32": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.18.20.tgz", + "integrity": "sha512-Wv7QBi3ID/rROT08SABTS7eV4hX26sVduqDOTe1MvGMjNd3EjOz4b7zeexIR62GTIEKrfJXKL9LFxTYgkyeu7g==", + "dev": true, + "optional": true + }, + "@esbuild/win32-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.18.20.tgz", + "integrity": "sha512-kTdfRcSiDfQca/y9QIkng02avJ+NCaQvrMejlsB3RRv5sE9rRoeBPISaZpKxHELzRxZyLvNts1P27W3wV+8geQ==", + "dev": true, + "optional": true + } } }, "esbuild-plugin-alias": { @@ -34138,7 +35571,8 @@ }, "esprima": { "version": "4.0.1", - "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==" + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true }, "esquery": { "version": "1.4.0", @@ -34354,7 +35788,8 @@ }, "fast-deep-equal": { "version": "3.1.3", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true }, "fast-glob": { "version": "3.2.11", @@ -34375,7 +35810,8 @@ }, "fast-json-stable-stringify": { "version": "2.1.0", - "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==" + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true }, "fast-levenshtein": { "version": "2.0.6", @@ -34838,6 +36274,7 @@ "fs-extra": { "version": "7.0.1", "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "dev": true, "requires": { "graceful-fs": "^4.1.2", "jsonfile": "^4.0.0", @@ -35289,7 +36726,8 @@ }, "graceful-fs": { "version": "4.2.9", - "integrity": "sha512-NtNxqUcXgpW2iMrfqSfR73Glt39K+BLwWsPs94yR63v45T0Wbej7eRmL5cWfwEgqXnmjQp3zaJTshdRW/qC2ZQ==" + "integrity": "sha512-NtNxqUcXgpW2iMrfqSfR73Glt39K+BLwWsPs94yR63v45T0Wbej7eRmL5cWfwEgqXnmjQp3zaJTshdRW/qC2ZQ==", + "dev": true }, "graphql": { "version": "15.8.0", @@ -35604,7 +37042,8 @@ }, "import-lazy": { "version": "4.0.0", - "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==" + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "dev": true }, "import-local": { "version": "3.1.0", @@ -38146,7 +39585,8 @@ }, "jju": { "version": "1.4.0", - "integrity": "sha1-o6vicYryQaKykE+EpiWXDzia4yo=" + "integrity": "sha1-o6vicYryQaKykE+EpiWXDzia4yo=", + "dev": true }, "joi": { "version": "17.11.0", @@ -38376,7 +39816,8 @@ }, "json-schema-traverse": { "version": "0.4.1", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true }, "json-stable-stringify-without-jsonify": { "version": "1.0.1", @@ -38398,6 +39839,7 @@ "jsonfile": { "version": "4.0.0", "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", + "dev": true, "requires": { "graceful-fs": "^4.1.6" } @@ -38583,11 +40025,13 @@ }, "lodash.get": { "version": "4.4.2", - "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=" + "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", + "dev": true }, "lodash.isequal": { "version": "4.5.0", - "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA=" + "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA=", + "dev": true }, "lodash.memoize": { "version": "4.1.2", @@ -38687,6 +40131,7 @@ "lru-cache": { "version": "6.0.0", "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, "requires": { "yallist": "^4.0.0" } @@ -40116,7 +41561,8 @@ }, "punycode": { "version": "2.1.1", - "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==" + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", + "dev": true }, "puppeteer-core": { "version": "2.1.1", @@ -40944,11 +42390,24 @@ } }, "rollup": { - "version": "3.29.2", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-3.29.2.tgz", - "integrity": "sha512-CJouHoZ27v6siztc21eEQGo0kIcE5D1gVPA571ez0mMYb25LGYGKnVNXpEj5MGlepmDWGXNjDB5q7uNiPHC11A==", - "dev": true, - "requires": { + "version": "4.9.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.9.0.tgz", + "integrity": "sha512-bUHW/9N21z64gw8s6tP4c88P382Bq/L5uZDowHlHx6s/QWpjJXivIAbEw6LZthgSvlEizZBfLC4OAvWe7aoF7A==", + "dev": true, + "requires": { + "@rollup/rollup-android-arm-eabi": "4.9.0", + "@rollup/rollup-android-arm64": "4.9.0", + "@rollup/rollup-darwin-arm64": "4.9.0", + "@rollup/rollup-darwin-x64": "4.9.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.9.0", + "@rollup/rollup-linux-arm64-gnu": "4.9.0", + "@rollup/rollup-linux-arm64-musl": "4.9.0", + "@rollup/rollup-linux-riscv64-gnu": "4.9.0", + "@rollup/rollup-linux-x64-gnu": "4.9.0", + "@rollup/rollup-linux-x64-musl": "4.9.0", + "@rollup/rollup-win32-arm64-msvc": "4.9.0", + "@rollup/rollup-win32-ia32-msvc": "4.9.0", + "@rollup/rollup-win32-x64-msvc": "4.9.0", "fsevents": "~2.3.2" } }, @@ -41361,7 +42820,8 @@ }, "sprintf-js": { "version": "1.0.3", - "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=" + "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", + "dev": true }, "ssim.js": { "version": "3.5.0", @@ -41452,7 +42912,8 @@ }, "string-argv": { "version": "0.3.1", - "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==" + "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "dev": true }, "string-length": { "version": "4.0.2", @@ -41568,7 +43029,8 @@ }, "strip-json-comments": { "version": "3.1.1", - "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==" + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true }, "style-loader": { "version": "3.3.3", @@ -41972,10 +43434,6 @@ } } }, - "timsort": { - "version": "0.3.0", - "integrity": "sha1-QFQRqOfmM5/mTbmiNN4R3DHgK9Q=" - }, "tiny-invariant": { "version": "1.3.1", "resolved": "https://registry.npmjs.org/tiny-invariant/-/tiny-invariant-1.3.1.tgz", @@ -42147,27 +43605,64 @@ "dev": true }, "tsup": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/tsup/-/tsup-7.2.0.tgz", - "integrity": "sha512-vDHlczXbgUvY3rWvqFEbSqmC1L7woozbzngMqTtL2PGBODTtWlRwGDDawhvWzr5c1QjKe4OAKqJGfE1xeXUvtQ==", + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/tsup/-/tsup-8.0.1.tgz", + "integrity": "sha512-hvW7gUSG96j53ZTSlT4j/KL0q1Q2l6TqGBFc6/mu/L46IoNWqLLUzLRLP1R8Q7xrJTmkDxxDoojV5uCVs1sVOg==", "dev": true, "requires": { "bundle-require": "^4.0.0", "cac": "^6.7.12", "chokidar": "^3.5.1", "debug": "^4.3.1", - "esbuild": "^0.18.2", + "esbuild": "^0.19.2", "execa": "^5.0.0", "globby": "^11.0.3", "joycon": "^3.0.1", "postcss-load-config": "^4.0.1", "resolve-from": "^5.0.0", - "rollup": "^3.2.5", + "rollup": "^4.0.2", "source-map": "0.8.0-beta.0", "sucrase": "^3.20.3", "tree-kill": "^1.2.2" }, "dependencies": { + "@esbuild/darwin-arm64": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.19.9.tgz", + "integrity": "sha512-KBJ9S0AFyLVx2E5D8W0vExqRW01WqRtczUZ8NRu+Pi+87opZn5tL4Y0xT0mA4FtHctd0ZgwNoN639fUUGlNIWw==", + "dev": true, + "optional": true + }, + "esbuild": { + "version": "0.19.9", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.19.9.tgz", + "integrity": "sha512-U9CHtKSy+EpPsEBa+/A2gMs/h3ylBC0H0KSqIg7tpztHerLi6nrrcoUJAkNCEPumx8yJ+Byic4BVwHgRbN0TBg==", + "dev": true, + "requires": { + "@esbuild/android-arm": "0.19.9", + "@esbuild/android-arm64": "0.19.9", + "@esbuild/android-x64": "0.19.9", + "@esbuild/darwin-arm64": "0.19.9", + "@esbuild/darwin-x64": "0.19.9", + "@esbuild/freebsd-arm64": "0.19.9", + "@esbuild/freebsd-x64": "0.19.9", + "@esbuild/linux-arm": "0.19.9", + "@esbuild/linux-arm64": "0.19.9", + "@esbuild/linux-ia32": "0.19.9", + "@esbuild/linux-loong64": "0.19.9", + "@esbuild/linux-mips64el": "0.19.9", + "@esbuild/linux-ppc64": "0.19.9", + "@esbuild/linux-riscv64": "0.19.9", + "@esbuild/linux-s390x": "0.19.9", + "@esbuild/linux-x64": "0.19.9", + "@esbuild/netbsd-x64": "0.19.9", + "@esbuild/openbsd-x64": "0.19.9", + "@esbuild/sunos-x64": "0.19.9", + "@esbuild/win32-arm64": "0.19.9", + "@esbuild/win32-ia32": "0.19.9", + "@esbuild/win32-x64": "0.19.9" + } + }, "source-map": { "version": "0.8.0-beta.0", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.8.0-beta.0.tgz", @@ -42363,7 +43858,8 @@ }, "universalify": { "version": "0.1.2", - "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==" + "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "dev": true }, "unpipe": { "version": "1.0.0", @@ -42410,6 +43906,7 @@ "uri-js": { "version": "4.4.1", "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, "requires": { "punycode": "^2.1.0" } @@ -42567,7 +44064,8 @@ }, "validator": { "version": "13.7.0", - "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==" + "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "dev": true }, "vary": { "version": "1.1.2", @@ -43051,7 +44549,8 @@ }, "yallist": { "version": "4.0.0", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==" + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true }, "yaml": { "version": "1.10.2", @@ -43097,6 +44596,7 @@ "z-schema": { "version": "5.0.2", "integrity": "sha512-40TH47ukMHq5HrzkeVE40Ad7eIDKaRV2b+Qpi2prLc9X9eFJFzV7tMe5aH12e6avaSS/u5l653EQOv+J9PirPw==", + "dev": true, "requires": { "commander": "^2.7.1", "lodash.get": "^4.4.2", diff --git a/package.json b/package.json index aab201d22..a58d17bfb 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@yext/search-ui-react", - "version": "1.4.0", + "version": "1.4.1", "description": "A library of React Components for powering Yext Search integrations", "author": "slapshot@yext.com", "license": "BSD-3-Clause", @@ -42,7 +42,8 @@ "build:css": "tailwindcss -o ./lib/bundle.css --minify -c tailwind.config.cjs && tailwindcss -o ./lib/bundle-no-resets.css --minify -c tailwind-no-resets.config.cjs", "dev": "tsc --watch -p tsconfig.json", "lint": "eslint . --max-warnings=0", - "api-extractor": "api-extractor run --local --verbose", + "api-extractor": "api-extractor run --local --verbose && npm run copyTypes", + "copyTypes": "cp dist/index.d.ts dist/index.d.mts && cp dist/index.d.mts lib/esm && cp dist/index.d.ts lib/commonjs", "generate-docs": "api-documenter markdown --input-folder temp --output-folder docs && rm -rf temp", "generate-notices": "generate-license-file --input package.json --output ./THIRD-PARTY-NOTICES --overwrite", "prepublishOnly": "npm run build", @@ -60,6 +61,8 @@ "@babel/preset-react": "^7.16.7", "@babel/preset-typescript": "^7.14.5", "@etchteam/storybook-addon-status": "^4.2.4", + "@microsoft/api-documenter": "^7.23.14", + "@microsoft/api-extractor": "^7.38.5", "@reduxjs/toolkit": "^1.8.6", "@storybook/addon-a11y": "^7.4.5", "@storybook/addon-actions": "^7.4.5", @@ -101,7 +104,7 @@ "storybook": "^7.4.5", "tailwindcss": "^3.0.23", "ts-jest": "^29.1.1", - "tsup": "^7.2.0", + "tsup": "^8.0.1", "typescript": "^5.2.2" }, "peerDependencies": { @@ -150,8 +153,6 @@ "restoreMocks": true }, "dependencies": { - "@microsoft/api-documenter": "^7.15.3", - "@microsoft/api-extractor": "^7.19.4", "@reach/auto-id": "^0.18.0", "@restart/ui": "^1.0.1", "@tailwindcss/forms": "^0.5.0", diff --git a/src/components/Facets.tsx b/src/components/Facets.tsx index 6cf257fca..d15f319f4 100644 --- a/src/components/Facets.tsx +++ b/src/components/Facets.tsx @@ -32,7 +32,7 @@ enum FacetType { * * @public */ -export function Facets(props: FacetsProps) { +export function Facets(props: FacetsProps): JSX.Element { const { searchOnChange, onlyRenderChildren = false, diff --git a/src/components/HierarchicalFacets.tsx b/src/components/HierarchicalFacets.tsx index 1226e44c2..ba53f8fde 100644 --- a/src/components/HierarchicalFacets.tsx +++ b/src/components/HierarchicalFacets.tsx @@ -55,7 +55,7 @@ export function HierarchicalFacets({ customCssClasses = {}, delimiter, showMoreLimit -}: HierarchicalFacetsProps) { +}: HierarchicalFacetsProps): JSX.Element { return ( {facets => facets diff --git a/src/components/MapboxMap.tsx b/src/components/MapboxMap.tsx index 2af76dbb0..623975a3f 100644 --- a/src/components/MapboxMap.tsx +++ b/src/components/MapboxMap.tsx @@ -91,7 +91,7 @@ export function MapboxMap({ PinComponent, getCoordinate = getDefaultCoordinate, onDrag -}: MapboxMapProps) { +}: MapboxMapProps): JSX.Element { useEffect(() => { mapboxgl.accessToken = mapboxAccessToken; }, [mapboxAccessToken]); diff --git a/src/components/NumericalFacets.tsx b/src/components/NumericalFacets.tsx index f11162327..6ecd79358 100644 --- a/src/components/NumericalFacets.tsx +++ b/src/components/NumericalFacets.tsx @@ -60,7 +60,7 @@ export function NumericalFacets({ inputPrefix = DEFAULT_RANGE_INPUT_PREFIX, customCssClasses = {}, ...filterGroupProps -}: NumericalFacetsProps) { +}: NumericalFacetsProps): JSX.Element { return ( {facets => facets diff --git a/src/components/StandardFacets.tsx b/src/components/StandardFacets.tsx index dc8e0a61d..6b653e122 100644 --- a/src/components/StandardFacets.tsx +++ b/src/components/StandardFacets.tsx @@ -61,7 +61,7 @@ export interface StandardFacetsProps { * @deprecated Use {@link Facets} instead. * @public */ -export function StandardFacets(props: StandardFacetsProps) { +export function StandardFacets(props: StandardFacetsProps): JSX.Element { const { searchOnChange, excludedFieldIds = [], diff --git a/src/utils/arrayutils.tsx b/src/utils/arrayutils.tsx deleted file mode 100644 index 02abdcc32..000000000 --- a/src/utils/arrayutils.tsx +++ /dev/null @@ -1,31 +0,0 @@ -/* eslint-disable @typescript-eslint/no-explicit-any */ - -type MapFunction = (element: any, index: number) => any; - -/** - * Reduces an array into an object consisting of groups. The keys of the object indicate the groups - * and the values hold an array of elements which are in that group. Mapping functions can be specified - * which determine the key and the value for the element. An initial object may be optionally specified. - * - * @param arr - array to be grouped - * @param keyMap - Mapping function that evaluates what key to give an array element. - * @param valueMap - Mapping function that evaluates what value to give an array element. - * @param intitial - the initial object to add to, defaulting to \{\} - */ -export function mapArrayToObject( - arr: Array, - keyMap: MapFunction = (key: any) => key, - valueMap: MapFunction = (value: any) => value, - initial: Record = {} -): Record { - return arr.reduce((groups, element, idx) => { - const key = keyMap(element, idx); - const value = valueMap(element, idx); - if (!groups[key]) { - groups[key] = [value]; - } else { - groups[key].push(value); - } - return groups; - }, initial); -} diff --git a/test-site/package-lock.json b/test-site/package-lock.json index 73936a4c0..0b08a0fbc 100644 --- a/test-site/package-lock.json +++ b/test-site/package-lock.json @@ -33,11 +33,9 @@ }, "..": { "name": "@yext/search-ui-react", - "version": "1.4.0", + "version": "1.4.1", "license": "BSD-3-Clause", "dependencies": { - "@microsoft/api-documenter": "^7.15.3", - "@microsoft/api-extractor": "^7.19.4", "@reach/auto-id": "^0.18.0", "@restart/ui": "^1.0.1", "@tailwindcss/forms": "^0.5.0", @@ -58,6 +56,8 @@ "@babel/preset-react": "^7.16.7", "@babel/preset-typescript": "^7.14.5", "@etchteam/storybook-addon-status": "^4.2.4", + "@microsoft/api-documenter": "^7.23.14", + "@microsoft/api-extractor": "^7.38.5", "@reduxjs/toolkit": "^1.8.6", "@storybook/addon-a11y": "^7.4.5", "@storybook/addon-actions": "^7.4.5", @@ -99,7 +99,7 @@ "storybook": "^7.4.5", "tailwindcss": "^3.0.23", "ts-jest": "^29.1.1", - "tsup": "^7.2.0", + "tsup": "^8.0.1", "typescript": "^5.2.2" }, "peerDependencies": { @@ -21962,8 +21962,8 @@ "@babel/preset-react": "^7.16.7", "@babel/preset-typescript": "^7.14.5", "@etchteam/storybook-addon-status": "^4.2.4", - "@microsoft/api-documenter": "^7.15.3", - "@microsoft/api-extractor": "^7.19.4", + "@microsoft/api-documenter": "^7.23.14", + "@microsoft/api-extractor": "^7.38.5", "@reach/auto-id": "^0.18.0", "@reduxjs/toolkit": "^1.8.6", "@restart/ui": "^1.0.1", @@ -22017,7 +22017,7 @@ "tailwind-merge": "^1.3.0", "tailwindcss": "^3.0.23", "ts-jest": "^29.1.1", - "tsup": "^7.2.0", + "tsup": "^8.0.1", "typescript": "^5.2.2", "use-isomorphic-layout-effect": "^1.1.2" },