From 756203fab8f0eb5d5009cdde14159a0e5f5db149 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Tue, 11 Feb 2020 15:24:09 +0100 Subject: [PATCH] Pull in collective hooks (from PR) (#2264) --- packages/react-hooks/src/index.ts | 3 ++ packages/react-hooks/src/types.ts | 6 ++++ packages/react-hooks/src/useAccountId.tsx | 20 ++++++++++++ packages/react-hooks/src/useCall.tsx | 2 +- packages/react-hooks/src/useMembers.tsx | 37 +++++++++++++++++++++++ packages/react-hooks/src/useModal.tsx | 25 +++++++++++++++ 6 files changed, 92 insertions(+), 1 deletion(-) create mode 100644 packages/react-hooks/src/useAccountId.tsx create mode 100644 packages/react-hooks/src/useMembers.tsx create mode 100644 packages/react-hooks/src/useModal.tsx diff --git a/packages/react-hooks/src/index.ts b/packages/react-hooks/src/index.ts index 3e0cea16ff..8763de9533 100644 --- a/packages/react-hooks/src/index.ts +++ b/packages/react-hooks/src/index.ts @@ -2,6 +2,7 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. +export { default as useAccountId } from './useAccountId'; export { default as useAccounts } from './useAccounts'; export { default as useAddresses } from './useAddresses'; export { default as useApi } from './useApi'; @@ -11,6 +12,8 @@ export { default as useForm } from './useForm'; export { default as useDebounce } from './useDebounce'; export { default as useFavorites } from './useFavorites'; export { default as useIsMountedRef } from './useIsMountedRef'; +export { default as useMembers } from './useMembers'; +export { default as useModal } from './useModal'; export { default as usePassword } from './usePassword'; export { default as useToggle } from './useToggle'; export { default as useTx } from './useTx'; diff --git a/packages/react-hooks/src/types.ts b/packages/react-hooks/src/types.ts index 1344aa8247..b7fb06414d 100644 --- a/packages/react-hooks/src/types.ts +++ b/packages/react-hooks/src/types.ts @@ -24,6 +24,12 @@ export type TxDefs = SubmittableExtrinsic | IExtrinsic | Call | TxDef | null; export type TxSource = [T, boolean]; +export interface ModalState { + isOpen: boolean; + onOpen: () => void; + onClose: () => void; +} + export interface Slash { accountId: AccountId; amount: Balance; diff --git a/packages/react-hooks/src/useAccountId.tsx b/packages/react-hooks/src/useAccountId.tsx new file mode 100644 index 0000000000..7818a716ec --- /dev/null +++ b/packages/react-hooks/src/useAccountId.tsx @@ -0,0 +1,20 @@ +// Copyright 2017-2020 @polkadot/react-hooks authors & contributors +// This software may be modified and distributed under the terms +// of the Apache-2.0 license. See the LICENSE file for details. + +import { StringOrNull } from '@polkadot/react-components/types'; + +import { useState } from 'react'; + +export default function useAccountId (initialValue: StringOrNull = null, onChangeAccountId?: (_: StringOrNull) => void): [StringOrNull, (_: StringOrNull) => void] { + const [accountId, setAccountId] = useState(initialValue); + + return [ + accountId, + (accountId: StringOrNull = null): void => { + setAccountId(accountId); + + onChangeAccountId && onChangeAccountId(accountId); + } + ]; +} diff --git a/packages/react-hooks/src/useCall.tsx b/packages/react-hooks/src/useCall.tsx index e75c525d98..11bb44c212 100644 --- a/packages/react-hooks/src/useCall.tsx +++ b/packages/react-hooks/src/useCall.tsx @@ -98,7 +98,7 @@ function subscribe (mounted: MountedRef, tracker: TrackerRef, fn: TrackFn | // - returns a promise with an unsubscribe function // - has a callback to set the value // FIXME The typings here need some serious TLC -export default function useCall (fn: TrackFn | undefined | null, params: CallParams, options: CallOptions = {}): T | undefined { +export default function useCall (fn: TrackFn | undefined | null, params: CallParams = [], options: CallOptions = {}): T | undefined { const mounted = useIsMountedRef(); const tracker = useRef({ isActive: false, count: 0, serialized: null, subscriber: null }); const [value, setValue] = useState(options.defaultValue); diff --git a/packages/react-hooks/src/useMembers.tsx b/packages/react-hooks/src/useMembers.tsx new file mode 100644 index 0000000000..ceb80aee52 --- /dev/null +++ b/packages/react-hooks/src/useMembers.tsx @@ -0,0 +1,37 @@ +// Copyright 2017-2020 @polkadot/app-democracy authors & contributors +// This software may be modified and distributed under the terms +// of the Apache-2.0 license. See the LICENSE file for details. + +import { AccountId, Balance } from '@polkadot/types/interfaces'; + +import { useAccounts, useApi, useCall } from '@polkadot/react-hooks'; + +interface Result { + isMember: boolean; + members: string[]; +} + +function getResult (allAccounts: string[], members: string[]): Result { + return { + isMember: members.some((accountId): boolean => allAccounts.includes(accountId)), + members + }; +} + +export default function useMembers (collective: 'council' | 'technicalCommittee'): Result { + const { api } = useApi(); + const { allAccounts } = useAccounts(); + const { isMember, members } = ( + collective === 'council' + ? useCall(api.query.electionsPhragmen?.members || api.query.elections.members, [], { + transform: (accounts: [AccountId, Balance][]): Result => + getResult(allAccounts, accounts.map(([accountId]) => accountId.toString())) + }) + : useCall(api.query.technicalCommittee.members, [], { + transform: (accounts: AccountId[]): Result => + getResult(allAccounts, accounts.map(accountId => accountId.toString())) + }) + ) || { isMember: false, members: [] }; + + return { isMember, members }; +} diff --git a/packages/react-hooks/src/useModal.tsx b/packages/react-hooks/src/useModal.tsx new file mode 100644 index 0000000000..51bddb194b --- /dev/null +++ b/packages/react-hooks/src/useModal.tsx @@ -0,0 +1,25 @@ +// Copyright 2017-2020 @polkadot/react-hooks authors & contributors +// This software may be modified and distributed under the terms +// of the Apache-2.0 license. See the LICENSE file for details. + +import { ModalState } from './types'; + +import useToggle from './useToggle'; + +export default function useModal (defaultIsOpen?: boolean, onOpen?: () => void, onClose?: () => void): ModalState { + const [isOpen, , setIsOpen] = useToggle(defaultIsOpen || false); + + return { + isOpen, + onOpen: (): void => { + setIsOpen(true); + + onOpen && onOpen(); + }, + onClose: (): void => { + setIsOpen(false); + + onClose && onClose(); + } + }; +}