跳转到主要内容

useRecoilValue(state)

返回给定 Recoil state 的值。

使用此 hook 会使组件隐式地订阅给定的 state。


function useRecoilValue<T>(state: RecoilValue<T>): T;

当一个组件需要在不写入 state 的情况下读取 state 时,推荐使用该 hook,因为该 hook 可以同时在只读 state可写 state 中使用。Atom 是可写 state,而 selector 可以是只读,也可以是可写的。更多信息,参考 selector()

在 React 组件中,使用本 hook 将会订阅该组件,并且在 state 更新时重新渲染该组件。该 hook 在 state 异常或者在异步解析时抛出异常。详细可以参考指南

示例#

import {atom, selector, useRecoilValue} from 'recoil';
const namesState = atom({
key: 'namesState',
default: ['', 'Ella', 'Chris', '', 'Paul'],
});
const filteredNamesState = selector({
key: 'filteredNamesState',
get: ({get}) => get(namesState).filter((str) => str !== ''),
});
function NameDisplay() {
const names = useRecoilValue(namesState);
const filteredNames = useRecoilValue(filteredNamesState);
return (
<>
Original names: {names.join(',')}
<br />
Filtered names: {filteredNames.join(',')}
</>
);
}