diff --git a/packages/app-accounts/src/modals/Derive.tsx b/packages/app-accounts/src/modals/Derive.tsx index 46ace9b59b38..cb92f63abea4 100644 --- a/packages/app-accounts/src/modals/Derive.tsx +++ b/packages/app-accounts/src/modals/Derive.tsx @@ -9,7 +9,7 @@ import { KeypairType } from '@polkadot/util-crypto/types'; import React, { useContext, useEffect, useState } from 'react'; import { AddressRow, Button, Input, InputAddress, Modal, Password, StatusContext } from '@polkadot/react-components'; -import { useDebounce } from '@polkadot/react-components/hooks'; +import { useDebounce } from '@polkadot/react-hooks'; import keyring from '@polkadot/ui-keyring'; import { keyExtractPath } from '@polkadot/util-crypto'; diff --git a/packages/app-explorer/src/index.tsx b/packages/app-explorer/src/index.tsx index efae407204a8..abe7755143e0 100644 --- a/packages/app-explorer/src/index.tsx +++ b/packages/app-explorer/src/index.tsx @@ -77,9 +77,5 @@ function ExplorerApp ({ basePath, className, t }: Props): React.ReactElement | null { - const [favorites] = useState(store.get(STORE_FAVS, [])); + const [favorites] = useFavorites(STORE_FAVS_BASE); const [next, setNext] = useState(); const [{ options, shortlist }, setShortlist] = useState<{ options: KeyringSectionOption[]; shortlist: string[] }>({ options: [], shortlist: [] }); diff --git a/packages/app-staking/src/Overview/Address.tsx b/packages/app-staking/src/Overview/Address.tsx index d76a8486f52d..95a607e9cb3e 100644 --- a/packages/app-staking/src/Overview/Address.tsx +++ b/packages/app-staking/src/Overview/Address.tsx @@ -27,10 +27,10 @@ interface Props extends I18nProps { isFavorite: boolean; lastAuthors?: string[]; myAccounts: string[]; - onFavorite: (accountId: string) => void; points?: Points; recentlyOnline?: DerivedHeartbeats; stakingInfo?: DerivedStaking; + toggleFavorite: (accountId: string) => void; withNominations?: boolean; } @@ -46,7 +46,7 @@ interface StakingState { const WITH_VALIDATOR_PREFS = { validatorPayment: true }; -function Address ({ address, authorsMap, className, defaultName, filter, isElected, isFavorite, lastAuthors, myAccounts, onFavorite, points, recentlyOnline, stakingInfo, t, withNominations = true }: Props): React.ReactElement | null { +function Address ({ address, authorsMap, className, defaultName, filter, isElected, isFavorite, lastAuthors, myAccounts, points, recentlyOnline, stakingInfo, t, toggleFavorite, withNominations = true }: Props): React.ReactElement | null { const { api, isSubstrateV2 } = useContext(ApiContext); const [extraInfo, setExtraInfo] = useState<[React.ReactNode, React.ReactNode][] | undefined>(); const [hasActivity, setHasActivity] = useState(true); @@ -122,7 +122,7 @@ function Address ({ address, authorsMap, className, defaultName, filter, isElect const lastBlockNumber = authorsMap[stashId]; const isAuthor = lastAuthors && lastAuthors.includes(stashId); - const _onFavorite = (): void => onFavorite(stashId); + const _onFavorite = (): void => toggleFavorite(stashId); const _onQueryStats = (): void => { window.location.hash = `/staking/query/${stashId}`; }; diff --git a/packages/app-staking/src/Overview/CurrentList.tsx b/packages/app-staking/src/Overview/CurrentList.tsx index 37e3097afb13..c6ba651c3c53 100644 --- a/packages/app-staking/src/Overview/CurrentList.tsx +++ b/packages/app-staking/src/Overview/CurrentList.tsx @@ -10,10 +10,10 @@ import { ValidatorFilter } from '../types'; import React, { useContext, useEffect, useState } from 'react'; import { ApiContext } from '@polkadot/react-api'; import { Columar, Column, Dropdown, FilterOverlay } from '@polkadot/react-components'; -import store from 'store'; +import { useFavorites } from '@polkadot/react-hooks'; import keyring from '@polkadot/ui-keyring'; -import { STORE_FAVS } from '../constants'; +import { STORE_FAVS_BASE } from '../constants'; import translate from '../translate'; import Address from './Address'; @@ -58,7 +58,7 @@ function accountsToString (accounts: AccountId[]): string[] { function CurrentList ({ authorsMap, lastAuthors, next, recentlyOnline, stakingOverview, t }: Props): React.ReactElement { const { isSubstrateV2 } = useContext(ApiContext); - const [favorites, setFavorites] = useState(store.get(STORE_FAVS, [])); + const [favorites, toggleFavorite] = useFavorites(STORE_FAVS_BASE); const [filter, setFilter] = useState('all'); const [myAccounts] = useState(keyring.getAccounts().map(({ address }): string => address)); const [{ elected, validators, waiting }, setFiltered] = useState<{ elected: AccountExtend[]; validators: AccountExtend[]; waiting: AccountExtend[] }>({ elected: [], validators: [], waiting: [] }); @@ -78,16 +78,6 @@ function CurrentList ({ authorsMap, lastAuthors, next, recentlyOnline, stakingOv } }, [favorites, next, stakingOverview]); - const _onFavorite = (accountId: string): void => - setFavorites( - store.set( - STORE_FAVS, - favorites.includes(accountId) - ? favorites.filter((thisOne): boolean => thisOne !== accountId) - : [...favorites, accountId] - ) - ); - const _renderColumn = (addresses: AccountExtend[], defaultName: string, withOnline: boolean): React.ReactNode => addresses.map(([address, isElected, isFavorite, points]): React.ReactNode => (
)); diff --git a/packages/app-staking/src/constants.ts b/packages/app-staking/src/constants.ts index 29ddae5e77fd..825c9db35058 100644 --- a/packages/app-staking/src/constants.ts +++ b/packages/app-staking/src/constants.ts @@ -2,4 +2,4 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -export const STORE_FAVS = 'staking:favorites'; +export const STORE_FAVS_BASE = 'staking:favorites'; diff --git a/packages/app-staking/src/index.tsx b/packages/app-staking/src/index.tsx index 7c1b321aa4d0..25fb6815517c 100644 --- a/packages/app-staking/src/index.tsx +++ b/packages/app-staking/src/index.tsx @@ -102,10 +102,6 @@ function App ({ allAccounts, allStashesAndControllers: [allStashes, allControlle export default withMulti( styled(App)` - .rx--updated { - background: transparent !important; - } - .staking--hidden { display: none; } diff --git a/packages/apps/src/SideBar/NodeInfo.tsx b/packages/apps/src/SideBar/NodeInfo.tsx index a837304dfad5..4ed6ea4c0f4c 100644 --- a/packages/apps/src/SideBar/NodeInfo.tsx +++ b/packages/apps/src/SideBar/NodeInfo.tsx @@ -49,8 +49,4 @@ export default styled(NodeInfo)` margin-bottom: 0.5rem; } } - - .rx--updated { - background: inherit !important; - } `; diff --git a/packages/react-components/src/AddressRow.tsx b/packages/react-components/src/AddressRow.tsx index de671005d315..4c5d31a6da74 100644 --- a/packages/react-components/src/AddressRow.tsx +++ b/packages/react-components/src/AddressRow.tsx @@ -90,7 +90,7 @@ class AddressRow extends Row { return (
diff --git a/packages/react-components/src/Row.tsx b/packages/react-components/src/Row.tsx index d4503c7b4765..a255b9bc27c4 100644 --- a/packages/react-components/src/Row.tsx +++ b/packages/react-components/src/Row.tsx @@ -17,12 +17,15 @@ import InputTags from './InputTags'; export const styles = ` text-align: left; - &.disabled { - filter: grayscale(100%); + &.isDisabled { opacity: 0.6; + + .ui--IdentityIcon { + filter: grayscale(100%); + } } - &.inline { + &.isInline { display: flex; .ui--Row-accountId { @@ -30,7 +33,7 @@ export const styles = ` } } - &.invalid { + &.isInvalid { .ui--Row-accountId, .ui--Row-icon { filter: grayscale(100); diff --git a/packages/react-hooks/LICENSE b/packages/react-hooks/LICENSE new file mode 100644 index 000000000000..0d381b2e97dc --- /dev/null +++ b/packages/react-hooks/LICENSE @@ -0,0 +1,201 @@ + 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: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) 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 + + (d) 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 + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/packages/react-hooks/README.md b/packages/react-hooks/README.md new file mode 100644 index 000000000000..16475f66001a --- /dev/null +++ b/packages/react-hooks/README.md @@ -0,0 +1,5 @@ +# @polkadot/react-hooks + +WARNING: This is an internal package to [polkadot-js/apps](https://github.com/polkadot-js/apps) so is not inteded (yet) for broad use. Since these are generic components, they will move to the [polkadot-js/ui](https://github.com/polkadot-js/ui) repo once deemed stable and usable. + +For the existing sharable components usable in external React-based projects, take a look at the [polkadot-js/ui documentation](https://polkadot.js.org/ui/) diff --git a/packages/react-hooks/package.json b/packages/react-hooks/package.json new file mode 100644 index 000000000000..d22d6a6cdfe6 --- /dev/null +++ b/packages/react-hooks/package.json @@ -0,0 +1,35 @@ +{ + "name": "@polkadot/react-hooks", + "version": "0.37.0-beta.73", + "description": "A collection of React hooks the Polkadot JS Apps UI", + "main": "index.js", + "keywords": [ + "Polkadot", + "React", + "RxJs" + ], + "author": "Jaco Greeff ", + "maintainers": [ + "Jaco Greeff " + ], + "contributors": [], + "license": "Apache-2.0", + "engines": { + "node": ">=8.0" + }, + "publishConfig": { + "access": "public", + "registry": "https://registry.npmjs.org" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/polkadot-js/ui.git" + }, + "bugs": { + "url": "https://github.com/polkadot-js/ui/issues" + }, + "homepage": "https://github.com/polkadot-js/ui/tree/master/packages/ui-reactive#readme", + "dependencies": { + "@babel/runtime": "^7.7.1" + } +} diff --git a/packages/react-components/src/hooks/debounce.tsx b/packages/react-hooks/src/debounce.tsx similarity index 100% rename from packages/react-components/src/hooks/debounce.tsx rename to packages/react-hooks/src/debounce.tsx diff --git a/packages/react-hooks/src/favorites.tsx b/packages/react-hooks/src/favorites.tsx new file mode 100644 index 000000000000..cc74ff1cd216 --- /dev/null +++ b/packages/react-hooks/src/favorites.tsx @@ -0,0 +1,28 @@ +// Copyright 2017-2019 @polkadot/react-components 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 { useContext, useState } from 'react'; +import store from 'store'; +import { ApiContext } from '@polkadot/react-api'; + +// hook for favorites with local storage +export default function useFavorites (storageKeyBase: string): [string[], (address: string) => void] { + const { api, isDevelopment } = useContext(ApiContext); + const keyName = `${storageKeyBase}:${isDevelopment ? 'development' : api.genesisHash}`; + + // retrieve from the new style first, if not available, fallback to old-style + const [favorites, setFavorites] = useState(store.get(keyName) || store.get(storageKeyBase, [])); + + const _toggleFavorite = (address: string): void => + setFavorites( + store.set( + keyName, + favorites.includes(address) + ? favorites.filter((accountId): boolean => address !== accountId) + : [...favorites, address] + ) + ); + + return [favorites, _toggleFavorite]; +} diff --git a/packages/react-components/src/hooks/index.ts b/packages/react-hooks/src/index.ts similarity index 82% rename from packages/react-components/src/hooks/index.ts rename to packages/react-hooks/src/index.ts index 0c61f0e9f174..40a542273c98 100644 --- a/packages/react-components/src/hooks/index.ts +++ b/packages/react-hooks/src/index.ts @@ -3,3 +3,4 @@ // of the Apache-2.0 license. See the LICENSE file for details. export { default as useDebounce } from './debounce'; +export { default as useFavorites } from './favorites'; diff --git a/tsconfig.json b/tsconfig.json index 49443fd44d9a..01579931eb44 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -53,6 +53,8 @@ "@polkadot/react-api/*": [ "packages/react-api/src/*" ], "@polkadot/react-components": [ "packages/react-components/src" ], "@polkadot/react-components/*": [ "packages/react-components/src/*" ], + "@polkadot/react-hooks": [ "packages/react-hooks/src" ], + "@polkadot/react-hooks/*": [ "packages/react-hooks/src/*" ], "@polkadot/react-params": [ "packages/react-params/src" ], "@polkadot/react-params/*": [ "packages/react-params/src/*" ], "@polkadot/react-query": [ "packages/react-query/src" ],