Rename useValueFromSearchParams

magento · May 3, 2019 · 7b7a3e6 · 7b7a3e6
1 parent 9619624
commit 7b7a3e6
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/..._tests__/useValueFromSearchParams.spec.js → ...rc/hooks/__tests__/useSearchParam.spec.js b/..._tests__/useValueFromSearchParams.spec.js → ...rc/hooks/__tests__/useSearchParam.spec.js
@@ -1,13 +1,13 @@
 import React from 'react';
 
-import { useValueFromSearchParams } from '../useValueFromSearchParams';
+import { useSearchParam } from '../useSearchParam';
 import createTestInstance from '../../util/createTestInstance';
 
 const log = jest.fn();
 const setValue = jest.fn();
 
 const Component = props => {
-    const hookProps = useValueFromSearchParams(props);
+    const hookProps = useSearchParam(props);
 
     log(hookProps);
 

diff --git a/...ine/src/hooks/useValueFromSearchParams.js → ...ges/peregrine/src/hooks/useSearchParam.js b/...ine/src/hooks/useValueFromSearchParams.js → ...ges/peregrine/src/hooks/useSearchParam.js
@@ -6,7 +6,7 @@ const getSearchParam = (parameter = '', location = window.location) => {
     return params.get(parameter) || '';
 };
 
-export const useValueFromSearchParams = props => {
+export const useSearchParam = props => {
     const { location, parameter, setValue } = props;
     const value = getSearchParam(parameter, location);
 

diff --git a/packages/peregrine/src/index.js b/packages/peregrine/src/index.js
@@ -7,7 +7,7 @@ export { useDocumentListener } from './hooks/useDocumentListener';
 export { useDropdown } from './hooks/useDropdown';
 export { useQuery } from './hooks/useQuery';
 export { useQueryResult } from './hooks/useQueryResult';
-export { useValueFromSearchParams } from './hooks/useValueFromSearchParams';
+export { useSearchParam } from './hooks/useSearchParam';
 
 // components
 export { default as ContainerChild } from './ContainerChild';

diff --git a/packages/venia-concept/__mocks__/@magento/peregrine.js b/packages/venia-concept/__mocks__/@magento/peregrine.js
@@ -18,7 +18,7 @@ const useDocumentListener = jest.fn(peregrine.useDocumentListener);
 const useDropdown = jest.fn(peregrine.useDropdown);
 const useQuery = jest.fn(peregrine.useQuery);
 const useQueryResult = jest.fn(peregrine.useQueryResult);
-const useValueFromSearchParams = jest.fn(peregrine.useValueFromSearchParams);
+const useSearchParam = jest.fn(peregrine.useSearchParam);
 
 // components
 
@@ -39,5 +39,5 @@ module.exports = {
     useDropdown,
     useQuery,
     useQueryResult,
-    useValueFromSearchParams
+    useSearchParam
 };
diff --git a/packages/venia-concept/src/components/SearchBar/searchField.js b/packages/venia-concept/src/components/SearchBar/searchField.js
@@ -3,7 +3,7 @@ import { func, shape, string } from 'prop-types';
 import { useFieldState, useFormApi } from 'informed';
 import ClearIcon from 'react-feather/dist/icons/x';
 import SearchIcon from 'react-feather/dist/icons/search';
-import { useValueFromSearchParams } from '@magento/peregrine';
+import { useSearchParam } from '@magento/peregrine';
 
 import Icon from 'src/components/Icon';
 import TextInput from 'src/components/TextInput';
@@ -32,7 +32,7 @@ const SearchField = props => {
         [formApi, onChange]
     );
 
-    useValueFromSearchParams({ location, parameter: 'query', setValue });
+    useSearchParam({ location, parameter: 'query', setValue });
 
     const resetForm = useCallback(() => {
         formApi.reset();