RepositoryCurrent collected state Current
Observed since 21 Oct, 08:55 UTC
No superseded metadata states collected. Unchanged observations do not create new revisions.
Back to packageRELEASE DETAILS
1.9.5
npm@0xgabi/ui
<p align=center> <img src="https://user-images.githubusercontent.com/36158/53582039-04dd2d00-3b7f-11e9-8460-803ed3b84cc6.png" alt="aragonUI"> </p>
Published10 Aug 2023
Direct dependencies62
Transitive dependenciesNot calculated
README
Current package documentation
Overview
aragonUI is a React library used to build user interfaces for Aragon and its related projects. It provides the components needed to build experiences that feel integrated with Aragon ecosystem, and can be used both client or server side.
The complete documentation can be found on the aragonUI website.
Getting Started
If you are unfamiliar with aragonUI, we recommend you to start with the getting started page. If you only want to know how to add aragonUI to your project, have a look at the quick setup:
Quick setup
Install aragonUI alongside styled-components from npm:
npm install --save @aragon/ui styled-components
Copy its assets into your public directory:
npx copy-aragon-ui-assets ./public
Wrap your app with the Main component:
import React from 'react'
import { Main } from '@aragon/ui'
function App() {
return (
<Main>
<h1>Hello aragonUI!</h1>
</Main>
)
}
Your project is now ready to use aragonUI. 💫
Open https://ui.aragon.org/ to see the list of the available components and learn how to use them.
Assets
aragonUI require some assets (e.g. fonts) in order to work properly. These need to be copied where they can be accessed by the library, like the public/ directory of a project using Create React App.
Copy these assets using the provided copy-aragon-ui-assets command:
npx copy-aragon-ui-assets ./public
By default, it will create a directory named aragon-ui in the specified directory.
This emplacement is communicated to the library through the <Main> component. The default path is ./aragon-ui/, but you can change it using the assetsUrl prop:
import { Main } from '@aragon/ui'
const App = () => (
<Main assetsUrl="http://example.com/aragon-ui-assets/">
<h1>Hello aragonUI!</h1>
</Main>
)
You may also want to add it as a build step in your project, so that aragonUI can be upgraded without having to worry about this.
"scripts": {
"sync-assets": "copy-aragon-ui-assets ./public",
"build": "npm run sync-assets && react-scripts build",
"start": "npm run sync-assets && react-scripts start"
}
See copy-aragon-ui-assets -h for more information.
Build and Develop
Clone this repository, install the dependencies:
npm install
Build:
npm run build
Auto rebuild:
npm run dev
Run the devbox (to develop a component in isolation):
# Assuming you are in the root aragon-ui directory (i.e. cd aragon-ui/)
# Link @aragon/ui locally and into the devbox package
yarn link
cd devbox/
yarn link @aragon/ui
cd ../
# Run devbox
yarn devbox
Projects using aragonUI
- Aragon client and core apps
- Autark’s Open Enterprise
- 1Hive’s Dandelion apps
- Aragon Black’s Fundraising
- pando
- P2P Models Wiki
- Auction App for Cyber Foundation
- 1Hive’s Apiary
- Uniswap Aragon App
- Compound Aragon App
- Aragon Parliament
- Aragon Market
License
MIT, see LICENSE.
Downloads & popularity
Awaiting observationsNo metric observations yet
Download counts and popularity will appear here as the collector receives them.
Declared dependencies 65
Native requirements62 direct targetsNot calculated transitive count
| Package / target | Requirement | Relationship |
|---|---|---|
@babel/runtimeEnvironment{
"local_name": "@babel/runtime",
"alias": false,
"peer_metadata": null
} | ^7.3.1 | runtime |
airbnb-prop-typesEnvironment{
"local_name": "airbnb-prop-types",
"alias": false,
"peer_metadata": null
} | ^2.9.0 | runtime |
argEnvironment{
"local_name": "arg",
"alias": false,
"peer_metadata": null
} | ^2.0.0 | runtime |
command-existsEnvironment{
"local_name": "command-exists",
"alias": false,
"peer_metadata": null
} | ^1.2.6 | runtime |
dayjsEnvironment{
"local_name": "dayjs",
"alias": false,
"peer_metadata": null
} | ^1.8.14 | runtime |
js-sha3Environment{
"local_name": "js-sha3",
"alias": false,
"peer_metadata": null
} | ^0.8.0 | runtime |
jsbiEnvironment{
"local_name": "jsbi",
"alias": false,
"peer_metadata": null
} | ^3.1.2 | runtime |
lodashEnvironment{
"local_name": "lodash",
"alias": false,
"peer_metadata": null
} | ^4.17.19 | runtime |
markdown-to-jsxEnvironment{
"local_name": "markdown-to-jsx",
"alias": false,
"peer_metadata": null
} | ^6.11.0 | runtime |
popper.jsEnvironment{
"local_name": "popper.js",
"alias": false,
"peer_metadata": null
} | ^1.14.4 | runtime |
prop-typesEnvironment{
"local_name": "prop-types",
"alias": false,
"peer_metadata": null
} | ^15.6.0 | runtime |
react-blockiesEnvironment{
"local_name": "react-blockies",
"alias": false,
"peer_metadata": null
} | ^1.4.0 | runtime |
react-display-nameEnvironment{
"local_name": "react-display-name",
"alias": false,
"peer_metadata": null
} | ^0.2.3 | runtime |
react-onclickoutEnvironment{
"local_name": "react-onclickout",
"alias": false,
"peer_metadata": null
} | ^2.0.8 | runtime |
react-springEnvironment{
"local_name": "react-spring",
"alias": false,
"peer_metadata": null
} | ^7.2.11 | runtime |
recursive-copyEnvironment{
"local_name": "recursive-copy",
"alias": false,
"peer_metadata": null
} | ^2.0.9 | runtime |
token-amountEnvironment{
"local_name": "token-amount",
"alias": false,
"peer_metadata": null
} | ^0.1.0 | runtime |
use-insideEnvironment{
"local_name": "use-inside",
"alias": false,
"peer_metadata": null
} | ^0.2.0 | runtime |
use-tokenEnvironment{
"local_name": "use-token",
"alias": false,
"peer_metadata": null
} | ^0.2.0 | runtime |
@babel/cliEnvironment{
"local_name": "@babel/cli",
"alias": false,
"peer_metadata": null
} | ^7.1.5 | development |
@babel/plugin-proposal-class-propertiesEnvironment{
"local_name": "@babel/plugin-proposal-class-properties",
"alias": false,
"peer_metadata": null
} | ^7.1.0 | development |
@babel/plugin-transform-react-jsxEnvironment{
"local_name": "@babel/plugin-transform-react-jsx",
"alias": false,
"peer_metadata": null
} | ^7.0.0 | development |
@babel/plugin-transform-runtimeEnvironment{
"local_name": "@babel/plugin-transform-runtime",
"alias": false,
"peer_metadata": null
} | ^7.2.0 | development |
@babel/preset-envEnvironment{
"local_name": "@babel/preset-env",
"alias": false,
"peer_metadata": null
} | ^7.8.7 | development |
@babel/preset-reactEnvironment{
"local_name": "@babel/preset-react",
"alias": false,
"peer_metadata": null
} | ^7.0.0 | development |
@rollup/plugin-babelEnvironment{
"local_name": "@rollup/plugin-babel",
"alias": false,
"peer_metadata": null
} | ^5.1.0 | development |
@rollup/plugin-commonjsEnvironment{
"local_name": "@rollup/plugin-commonjs",
"alias": false,
"peer_metadata": null
} | ^13.0.2 | development |
@rollup/plugin-node-resolveEnvironment{
"local_name": "@rollup/plugin-node-resolve",
"alias": false,
"peer_metadata": null
} | ^8.4.0 | development |
@rollup/plugin-urlEnvironment{
"local_name": "@rollup/plugin-url",
"alias": false,
"peer_metadata": null
} | ^5.0.1 | development |
@svgr/coreEnvironment{
"local_name": "@svgr/core",
"alias": false,
"peer_metadata": null
} | ^4.1.0 | development |
@svgr/plugin-prettierEnvironment{
"local_name": "@svgr/plugin-prettier",
"alias": false,
"peer_metadata": null
} | ^4.0.3 | development |
@testing-library/jest-domEnvironment{
"local_name": "@testing-library/jest-dom",
"alias": false,
"peer_metadata": null
} | ^5.1.1 | development |
@testing-library/reactEnvironment{
"local_name": "@testing-library/react",
"alias": false,
"peer_metadata": null
} | ^9.5.0 | development |
babel-eslintEnvironment{
"local_name": "babel-eslint",
"alias": false,
"peer_metadata": null
} | ^10.0.1 | development |
babel-plugin-styled-componentsEnvironment{
"local_name": "babel-plugin-styled-components",
"alias": false,
"peer_metadata": null
} | ^1.10.6 | development |
eslintEnvironment{
"local_name": "eslint",
"alias": false,
"peer_metadata": null
} | ^7.6.0 | development |
eslint-config-prettierEnvironment{
"local_name": "eslint-config-prettier",
"alias": false,
"peer_metadata": null
} | ^4.3.0 | development |
eslint-config-standardEnvironment{
"local_name": "eslint-config-standard",
"alias": false,
"peer_metadata": null
} | ^12.0.0 | development |
eslint-config-standard-reactEnvironment{
"local_name": "eslint-config-standard-react",
"alias": false,
"peer_metadata": null
} | ^7.0.2 | development |
eslint-plugin-importEnvironment{
"local_name": "eslint-plugin-import",
"alias": false,
"peer_metadata": null
} | ^2.8.0 | development |
eslint-plugin-jestEnvironment{
"local_name": "eslint-plugin-jest",
"alias": false,
"peer_metadata": null
} | ^22.5.1 | development |
eslint-plugin-nodeEnvironment{
"local_name": "eslint-plugin-node",
"alias": false,
"peer_metadata": null
} | ^9.0.1 | development |
eslint-plugin-prettierEnvironment{
"local_name": "eslint-plugin-prettier",
"alias": false,
"peer_metadata": null
} | ^3.0.0 | development |
eslint-plugin-promiseEnvironment{
"local_name": "eslint-plugin-promise",
"alias": false,
"peer_metadata": null
} | ^4.0.1 | development |
eslint-plugin-reactEnvironment{
"local_name": "eslint-plugin-react",
"alias": false,
"peer_metadata": null
} | ^7.4.0 | development |
eslint-plugin-react-hooksEnvironment{
"local_name": "eslint-plugin-react-hooks",
"alias": false,
"peer_metadata": null
} | ^2.0.1 | development |
eslint-plugin-standardEnvironment{
"local_name": "eslint-plugin-standard",
"alias": false,
"peer_metadata": null
} | ^4.0.0 | development |
fast-globEnvironment{
"local_name": "fast-glob",
"alias": false,
"peer_metadata": null
} | ^3.1.1 | development |
gh-pagesEnvironment{
"local_name": "gh-pages",
"alias": false,
"peer_metadata": null
} | ^2.1.1 | development |
har-validatorEnvironment{
"local_name": "har-validator",
"alias": false,
"peer_metadata": null
} | ^5.1.3 | development |
huskyEnvironment{
"local_name": "husky",
"alias": false,
"peer_metadata": null
} | ^1.1.4 | development |
jestEnvironment{
"local_name": "jest",
"alias": false,
"peer_metadata": null
} | ^25.3.0 | development |
lint-stagedEnvironment{
"local_name": "lint-staged",
"alias": false,
"peer_metadata": null
} | ^8.1.0 | development |
listrEnvironment{
"local_name": "listr",
"alias": false,
"peer_metadata": null
} | ^0.14.3 | development |
prettierEnvironment{
"local_name": "prettier",
"alias": false,
"peer_metadata": null
} | ^1.19.0 | development |
reactEnvironment{
"local_name": "react",
"alias": false,
"peer_metadata": null
} | ^16.3.1 | development |
react-domEnvironment{
"local_name": "react-dom",
"alias": false,
"peer_metadata": null
} | ^16.3.1 | development |
rollupEnvironment{
"local_name": "rollup",
"alias": false,
"peer_metadata": null
} | ^2.23.0 | development |
rollup-plugin-analyzerEnvironment{
"local_name": "rollup-plugin-analyzer",
"alias": false,
"peer_metadata": null
} | ^3.3.0 | development |
rollup-plugin-progressEnvironment{
"local_name": "rollup-plugin-progress",
"alias": false,
"peer_metadata": null
} | ^1.1.2 | development |
styled-componentsEnvironment{
"local_name": "styled-components",
"alias": false,
"peer_metadata": null
} | >=4.0.0 | development |
svgoEnvironment{
"local_name": "svgo",
"alias": false,
"peer_metadata": null
} | ^1.2.2 | development |
reactEnvironment{
"local_name": "react",
"alias": false,
"peer_metadata": null
} | ^16.3.1 | peer |
react-domEnvironment{
"local_name": "react-dom",
"alias": false,
"peer_metadata": null
} | ^16.3.1 | peer |
styled-componentsEnvironment{
"local_name": "styled-components",
"alias": false,
"peer_metadata": null
} | >=4.0.0 | peer |
Distribution files
1 collectedDistribution 1
Source fileSource distribution
Checksums from source
{
"integrity": "sha512-lLMXeKKE2iobUXOW22DLMa4wL49XQ/wckbSKuW2CVvj4Z14FOsMTMqZU4LiQqFv+UhYAgAiKe6LAIo1fA9y2Tw==",
"shasum": "9f2c052d6b6015972c98fad7d73c0e1cb5b82dfb",
"tarball": "https://registry.npmjs.org/@0xgabi/ui/-/ui-1.9.5.tgz",
"fileCount": 1454,
"unpackedSize": 7292649,
"signatures": [
{
"keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
"sig": "MEUCIQDGSqdRoy7GIhjmOAvNUQkHgj/2HB0avQDDKtgq76BXRQIgLZfvtux2bw71rlj+Y62HQboCguS5WQEBm87xlBN6VS4="
}
]
}Repository
PENDINGMetadata history
Meaningful changesRecord identity
package_version:997c83f0639d8ae04ddde32e634da6d2cf062aa0addd769ea8be2dbeeefc645f