{"_id":"@alien-worlds/uikit","_rev":"4-f07ae876452569bf347d2ea2c6e3f16f","name":"@alien-worlds/uikit","dist-tags":{"latest":"0.5.8"},"versions":{"0.5.5":{"name":"@alien-worlds/uikit","version":"0.5.5","keywords":[],"author":{"name":"Alien Worlds"},"license":"MIT","_id":"@alien-worlds/uikit@0.5.5","maintainers":[{"name":"dallas.johnson","email":"dallasj001@gmail.com"},{"name":"lbobka","email":"volodymyr@dacoco.io"},{"name":"salman.gurmani","email":"muhammad.g@dacoco.io"}],"homepage":"https://github.com/Alien-Worlds/uikit#readme","bugs":{"url":"https://github.com/Alien-Worlds/uikit/issues"},"dist":{"shasum":"7645d08929f2f350a300df6f890addc728a6461f","tarball":"https://registry.npmjs.org/@alien-worlds/uikit/-/uikit-0.5.5.tgz","fileCount":337,"integrity":"sha512-ZId4HyremH2Sa5A2nm13g3KL7wn6+lPW/K3vYFa4KL8AMba3VIuBPYqoUgLnys8BBwDYMjtY9lmb5BTq9qLQaA==","signatures":[{"sig":"MEQCIFR17FFpQwe+D0gsfLx8AXajMmFWv6MNFhiLtHQDS6RxAiBzZL9iqic2nznfnAtG4akXqj+aVe1KStO3b7g+xI0LIw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":3003468},"main":"dist/cjs/index.js","types":"dist/index.d.ts","module":"dist/esm/index.js","browser":"dist/uikit.js","gitHead":"a0654662a95e9be98c691885a3931a81c53eee4d","scripts":{"lint":"tsc --noEmit && eslint src/**/*.ts{,x}","test":"jest -u","build":"npm run clean && npm run format-and-fix && npm run check:prebuild && rollup -c","clean":"rimraf dist","format":"prettier src/**/*.{ts,tsx,json,css} ","factory":"node factory.ts","prepare":"husky install","release":"npm run build && npm publish","storybook":"storybook dev -p 6006 public","test:watch":"jest --watch","lint:js:fix":"eslint --fix .","format:check":"npm run format -- --check","format:write":"npm run format -- --write","lint:js:check":"eslint .","test:coverage":"CI=true npm run test --coverage","check:prebuild":"npm run format:check ","format-and-fix":"npm run format:write && npm run lint:js:fix","storybook-docs":"storybook dev --docs","test-storybook":"test-storybook --watchAll","build-storybook":" rimraf storybook-static && mkdir storybook-static && storybook build","build-storybook-docs":"storybook build --docs"},"_npmUser":{"name":"salman.gurmani","email":"muhammad.g@dacoco.io"},"overrides":{"yaml":"^1.10.3","@babel/runtime":"^7.26.10"},"repository":{"url":"git+ssh://git@github.com/Alien-Worlds/uikit.git","type":"git"},"_npmVersion":"10.8.2","description":"
","directories":{},"lint-staged":{"src/**/*.{ts,jsx,tsx}":["eslint --fix","prettier --write"]},"_nodeVersion":"20.20.0","dependencies":{"react-icons":"^4.10.1","react-select":"^5.8.0","@emotion/react":"^11.11.3","@popperjs/core":"^2.11.8","react-toastify":"^8.2.0","@emotion/styled":"^11.11.0"},"eslintConfig":{"extends":["react-app","react-app/jest"],"overrides":[{"files":["**/*.stories.*"],"rules":{"import/no-anonymous-default-export":"off"}}]},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^27.5.1","uuid":"^8.3.2","husky":"^8.0.3","ramda":"^0.28.0","react":"^18.2.0","formik":"^2.2.9","rimraf":"^3.0.2","rollup":"^2.56.2","stable":"^0.1.8","prettier":"^2.5.1","react-dom":"^18.2.0","storybook":"^7.6.17","typescript":"^4.3.5","webpackbar":"^5.0.2","xml-loader":"^1.2.1","@babel/core":"^7.17.9","@types/jest":"^27.4.1","@types/uuid":"^8.3.4","lint-staged":"^13.2.3","postcss-url":"^10.1.3","querystring":"^0.2.1","react-color":"^2.19.3","@babel/types":"^7.17.0","@svgr/rollup":"^6.3.0","@types/ramda":"^0.28.9","@types/react":"^17.0.18","babel-loader":"^8.2.4","@emotion/jest":"^11.8.0","framer-motion":"^4.1.17","css-mediaquery":"^0.1.2","svg-url-loader":"^7.1.1","@storybook/react":"^7.6.17","svg-react-loader":"^0.4.6","@babel/preset-env":"^7.16.11","@types/file-saver":"^2.0.5","rollup-plugin-dts":"^3.0.2","svg-inline-loader":"^0.8.2","@rollup/plugin-url":"^6.1.0","@storybook/theming":"^7.6.17","@types/react-color":"^3.0.6","eslint-plugin-jest":"^26.1.1","@babel/preset-react":"^7.16.7","@rollup/plugin-json":"^4.1.0","babel-plugin-macros":"^3.1.0","copy-webpack-plugin":"^10.2.4","external-svg-loader":"^1.6.9","react-test-renderer":"^18.2.0","@rollup/plugin-babel":"^5.3.1","@rollup/plugin-image":"^2.1.1","eslint-plugin-import":"^2.27.5","rollup-plugin-terser":"^7.0.2","@emotion/babel-plugin":"^11.9.2","@storybook/addon-a11y":"^7.6.17","@storybook/addon-docs":"^7.6.17","@types/css-mediaquery":"^0.1.1","postcss-inline-base64":"^7.2.2","rollup-plugin-postcss":"^4.0.1","@storybook/addon-links":"^7.6.17","@storybook/manager-api":"^7.6.17","@storybook/node-logger":"^7.6.17","@storybook/test-runner":"^0.16.0","eslint-config-prettier":"^8.5.0","eslint-plugin-prettier":"^4.0.0","@rollup/plugin-commonjs":"^20.0.0","eslint-plugin-storybook":"^0.6.15","react-docgen-typescript":"^2.2.2","storybook-addon-designs":"^7.0.0-beta.2","@babel/preset-typescript":"^7.16.7","@storybook/addon-actions":"^7.6.17","@storybook/addon-mdx-gfm":"^7.6.17","@storybook/addon-styling":"^1.3.7","@rollup/plugin-typescript":"^8.2.5","@storybook/addon-controls":"^7.6.17","@storybook/addon-viewport":"^7.6.17","@storybook/react-webpack5":"^7.6.17","@typescript-eslint/parser":"^5.14.0","@types/react-test-renderer":"^17.0.2","rollup-plugin-node-globals":"^1.4.0","@rollup/plugin-node-resolve":"^13.0.4","@storybook/addon-essentials":"^7.6.17","rollup-plugin-node-builtins":"^2.1.2","storybook-preset-inline-svg":"^1.0.1","@babel/helper-module-imports":"^7.16.7","@storybook/addon-backgrounds":"^7.6.17","@storybook/addon-storysource":"^7.6.17","rollup-plugin-node-polyfills":"^0.2.1","storybook-addon-react-docgen":"^1.2.44","@storybook/addon-interactions":"^7.6.17","@emotion/babel-preset-css-prop":"^11.2.0","react-docgen-typescript-loader":"^3.7.2","@babel/plugin-transform-runtime":"^7.17.0","eslint-config-airbnb-typescript":"^16.1.2","@typescript-eslint/eslint-plugin":"^5.14.0","rollup-plugin-peer-deps-external":"^2.2.4","@storybook/preset-create-react-app":"^7.6.17","eslint-plugin-better-styled-components":"^1.1.2","@babel/plugin-proposal-private-property-in-object":"^7.21.11","@babel/plugin-transform-private-property-in-object":"^7.23.4"},"_npmOperationalInternal":{"tmp":"tmp/uikit_0.5.5_1776683317055_0.6112113422614254","host":"s3://npm-registry-packages-npm-production"}},"0.5.6":{"name":"@alien-worlds/uikit","version":"0.5.6","keywords":[],"author":{"name":"Alien Worlds"},"license":"MIT","_id":"@alien-worlds/uikit@0.5.6","maintainers":[{"name":"dallas.johnson","email":"dallasj001@gmail.com"},{"name":"lbobka","email":"volodymyr@dacoco.io"},{"name":"salman.gurmani","email":"muhammad.g@dacoco.io"}],"homepage":"https://github.com/Alien-Worlds/uikit#readme","bugs":{"url":"https://github.com/Alien-Worlds/uikit/issues"},"dist":{"shasum":"69039c486396472c25ea6b4071e198df95f68670","tarball":"https://registry.npmjs.org/@alien-worlds/uikit/-/uikit-0.5.6.tgz","fileCount":337,"integrity":"sha512-vIMW39NwxjdO4q1P2V3ViPg5EO0hmb5BLIrMcAXhLk5HQbYxOJQW5cYgxWjVWbmh2B0t16Hss55kkAQkkkIIXQ==","signatures":[{"sig":"MEYCIQDXrgR3q/9r+3HR9B0NnOLjT5OmKtQQwRxXRkRhO4VkdQIhAOmkftdRRBfNhHbb3il8fX0LKzwqluGZLpUKkRDVRDKH","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":3003719},"main":"dist/cjs/index.js","types":"dist/index.d.ts","module":"dist/esm/index.js","browser":"dist/uikit.js","gitHead":"a0654662a95e9be98c691885a3931a81c53eee4d","scripts":{"lint":"tsc --noEmit && eslint src/**/*.ts{,x}","test":"jest -u","build":"npm run clean && npm run format-and-fix && npm run check:prebuild && rollup -c","clean":"rimraf dist","format":"prettier src/**/*.{ts,tsx,json,css} ","factory":"node factory.ts","prepare":"husky install","release":"npm run build && npm publish","storybook":"storybook dev -p 6006 public","test:watch":"jest --watch","lint:js:fix":"eslint --fix .","format:check":"npm run format -- --check","format:write":"npm run format -- --write","lint:js:check":"eslint .","test:coverage":"CI=true npm run test --coverage","check:prebuild":"npm run format:check ","format-and-fix":"npm run format:write && npm run lint:js:fix","storybook-docs":"storybook dev --docs","test-storybook":"test-storybook --watchAll","build-storybook":" rimraf storybook-static && mkdir storybook-static && storybook build","build-storybook-docs":"storybook build --docs"},"_npmUser":{"name":"salman.gurmani","email":"muhammad.g@dacoco.io"},"overrides":{"yaml":"^1.10.3","@babel/runtime":"^7.26.10"},"repository":{"url":"git+ssh://git@github.com/Alien-Worlds/uikit.git","type":"git"},"_npmVersion":"10.8.2","description":"
","directories":{},"lint-staged":{"src/**/*.{ts,jsx,tsx}":["eslint --fix","prettier --write"]},"_nodeVersion":"20.20.0","dependencies":{"react-icons":"^4.10.1","react-select":"^5.8.0","@emotion/react":"^11.11.3","@popperjs/core":"^2.11.8","react-toastify":"^8.2.0","@emotion/styled":"^11.11.0"},"eslintConfig":{"extends":["react-app","react-app/jest"],"overrides":[{"files":["**/*.stories.*"],"rules":{"import/no-anonymous-default-export":"off"}}]},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^27.5.1","uuid":"^8.3.2","husky":"^8.0.3","ramda":"^0.28.0","react":"^18.2.0","formik":"^2.2.9","rimraf":"^3.0.2","rollup":"^2.56.2","stable":"^0.1.8","prettier":"^2.5.1","react-dom":"^18.2.0","storybook":"^7.6.17","typescript":"^4.3.5","webpackbar":"^5.0.2","xml-loader":"^1.2.1","@babel/core":"^7.17.9","@types/jest":"^27.4.1","@types/uuid":"^8.3.4","lint-staged":"^13.2.3","postcss-url":"^10.1.3","querystring":"^0.2.1","react-color":"^2.19.3","@babel/types":"^7.17.0","@svgr/rollup":"^6.3.0","@types/ramda":"^0.28.9","@types/react":"^17.0.18","babel-loader":"^8.2.4","@emotion/jest":"^11.8.0","framer-motion":"^4.1.17","css-mediaquery":"^0.1.2","svg-url-loader":"^7.1.1","@storybook/react":"^7.6.17","svg-react-loader":"^0.4.6","@babel/preset-env":"^7.16.11","@types/file-saver":"^2.0.5","rollup-plugin-dts":"^3.0.2","svg-inline-loader":"^0.8.2","@rollup/plugin-url":"^6.1.0","@storybook/theming":"^7.6.17","@types/react-color":"^3.0.6","eslint-plugin-jest":"^26.1.1","@babel/preset-react":"^7.16.7","@rollup/plugin-json":"^4.1.0","babel-plugin-macros":"^3.1.0","copy-webpack-plugin":"^10.2.4","external-svg-loader":"^1.6.9","react-test-renderer":"^18.2.0","@rollup/plugin-babel":"^5.3.1","@rollup/plugin-image":"^2.1.1","eslint-plugin-import":"^2.27.5","rollup-plugin-terser":"^7.0.2","@emotion/babel-plugin":"^11.9.2","@storybook/addon-a11y":"^7.6.17","@storybook/addon-docs":"^7.6.17","@types/css-mediaquery":"^0.1.1","postcss-inline-base64":"^7.2.2","rollup-plugin-postcss":"^4.0.1","@storybook/addon-links":"^7.6.17","@storybook/manager-api":"^7.6.17","@storybook/node-logger":"^7.6.17","@storybook/test-runner":"^0.16.0","eslint-config-prettier":"^8.5.0","eslint-plugin-prettier":"^4.0.0","@rollup/plugin-commonjs":"^20.0.0","eslint-plugin-storybook":"^0.6.15","react-docgen-typescript":"^2.2.2","storybook-addon-designs":"^7.0.0-beta.2","@babel/preset-typescript":"^7.16.7","@storybook/addon-actions":"^7.6.17","@storybook/addon-mdx-gfm":"^7.6.17","@storybook/addon-styling":"^1.3.7","@rollup/plugin-typescript":"^8.2.5","@storybook/addon-controls":"^7.6.17","@storybook/addon-viewport":"^7.6.17","@storybook/react-webpack5":"^7.6.17","@typescript-eslint/parser":"^5.14.0","@types/react-test-renderer":"^17.0.2","rollup-plugin-node-globals":"^1.4.0","@rollup/plugin-node-resolve":"^13.0.4","@storybook/addon-essentials":"^7.6.17","rollup-plugin-node-builtins":"^2.1.2","storybook-preset-inline-svg":"^1.0.1","@babel/helper-module-imports":"^7.16.7","@storybook/addon-backgrounds":"^7.6.17","@storybook/addon-storysource":"^7.6.17","rollup-plugin-node-polyfills":"^0.2.1","storybook-addon-react-docgen":"^1.2.44","@storybook/addon-interactions":"^7.6.17","@emotion/babel-preset-css-prop":"^11.2.0","react-docgen-typescript-loader":"^3.7.2","@babel/plugin-transform-runtime":"^7.17.0","eslint-config-airbnb-typescript":"^16.1.2","@typescript-eslint/eslint-plugin":"^5.14.0","rollup-plugin-peer-deps-external":"^2.2.4","@storybook/preset-create-react-app":"^7.6.17","eslint-plugin-better-styled-components":"^1.1.2","@babel/plugin-proposal-private-property-in-object":"^7.21.11","@babel/plugin-transform-private-property-in-object":"^7.23.4"},"_npmOperationalInternal":{"tmp":"tmp/uikit_0.5.6_1776688766742_0.9541444522280291","host":"s3://npm-registry-packages-npm-production"}},"0.5.7":{"name":"@alien-worlds/uikit","version":"0.5.7","keywords":[],"author":{"name":"Alien Worlds"},"license":"MIT","_id":"@alien-worlds/uikit@0.5.7","maintainers":[{"name":"dallas.johnson","email":"dallasj001@gmail.com"},{"name":"lbobka","email":"volodymyr@dacoco.io"},{"name":"salman.gurmani","email":"muhammad.g@dacoco.io"}],"homepage":"https://github.com/Alien-Worlds/uikit#readme","bugs":{"url":"https://github.com/Alien-Worlds/uikit/issues"},"dist":{"shasum":"9b68d3f09cb5f1518c96e691062fe45b4ea1c7ad","tarball":"https://registry.npmjs.org/@alien-worlds/uikit/-/uikit-0.5.7.tgz","fileCount":337,"integrity":"sha512-5AXSqI9oug/F46Xq+ycAkVcexd30a2MsIABsSAy5P78l04YlNzKxtR9iYpL3ujr+VbJLnVPJXR3YzAjQndmbJA==","signatures":[{"sig":"MEYCIQCWd1cBJk0MNkABmagJuJ4ONh5Ndh9oKBwOUX+VLpNXNgIhAKVJJr3o+aUlxh6dKfbDgZzS/R8JjCxWaD8kXXhPXwcY","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":2101761},"main":"dist/cjs/index.js","types":"dist/index.d.ts","module":"dist/esm/index.js","browser":"dist/uikit.js","gitHead":"a0654662a95e9be98c691885a3931a81c53eee4d","scripts":{"lint":"tsc --noEmit && eslint src/**/*.ts{,x}","test":"jest -u","build":"npm run clean && npm run format-and-fix && npm run check:prebuild && rollup -c","clean":"rimraf dist","format":"prettier src/**/*.{ts,tsx,json,css} ","factory":"node factory.ts","prepare":"husky install","release":"npm run build && npm publish","storybook":"storybook dev -p 6006 public","test:watch":"jest --watch","lint:js:fix":"eslint --fix .","format:check":"npm run format -- --check","format:write":"npm run format -- --write","lint:js:check":"eslint .","test:coverage":"CI=true npm run test --coverage","check:prebuild":"npm run format:check ","format-and-fix":"npm run format:write && npm run lint:js:fix","storybook-docs":"storybook dev --docs","test-storybook":"test-storybook --watchAll","build-storybook":" rimraf storybook-static && mkdir storybook-static && storybook build","build-storybook-docs":"storybook build --docs"},"_npmUser":{"name":"salman.gurmani","email":"muhammad.g@dacoco.io"},"overrides":{"yaml":"^1.10.3","@babel/runtime":"^7.26.10"},"repository":{"url":"git+ssh://git@github.com/Alien-Worlds/uikit.git","type":"git"},"_npmVersion":"10.8.2","description":"
\n \n\n\n## Table of Contents\n- [Table of Contents](#table-of-contents)\n- [Tech Stack](#tech-stack)\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n- [Development](#development)\n- [Releases](#releases)\n- [Notes](#notes)\n\n \n## Tech Stack\nBuilding components used of the project:\n\n- 📚 [Storybook](https://storybook.js.org) for UI component development and [auto-generated docs](https://medium.com/storybookjs/storybook-docs-sneak-peak-5be78445094a)\n- 👩🎤 [Storybook theming |](https://emotion.sh/) for component-scoped styling\n- ⚛️ [React](https://reactjs.org/) declarative component-centric UI\n- ⚛️ [ChakraUI](https://chakra-ui.com/) declarative component-centric UI and components are extended via this. \n- ⚛️ [JEST](https://jestjs.io/) Testing of Components are covered by JEST (React/Testing Library)\n\n\n## Prerequisites\nTo work with this repository locally, ensure you have:\n\n- Node.js 20+ and npm available in your shell.\n- An npm account only if you intend to publish packages.\n\n\n## Installation\nTo install AW's UI-kit library into an existing project, execute the command:\n```bash\nnpm install --save @alienworlds/uikit\n```\n\nTo import the UI-kit components into the project:\n```javascript\nimport { Button } from '@alienworlds/uikit';\n\n\n```\n\n## Development\nIn order to run the project in a development environment, from the repository folder type in your terminal:\n```\nnpm install\n```\nTo compile the project with all required dependencies, from the repository folder type in your terminal:\n```\nnpm run storybook\n```\nThis will compile the required dependencies and run the application in the browser.\n\n\n## Releases\nRegarding the version number:\n- Use the alpha version 0.x.x-alpha-1.0 to test the new version in the game-ui. This is also useful during development to ensure proper testing.\n- Update the minor or patch version number when you are ready to release the new changes.\n\nThere are two separate releases: one for uikit and one for icon. Please follow these steps:\n\nTo release uikit:\n- Ensure that you are in the root directory.\n- Proceed with the release process.\n\nTo release icon:\n- Navigate to the src/packages/icons directory.\n- Proceed with the release process from there.\n\nSteps to release a new version:\n1. Ensure that you are using Node.js 20+ and a recent npm version.\n2. Confirm that you have updated the version number in the package.json file as mentioned above.\n3. Execute the command npm run release.\n\n## Notes\n\n- Installing public packages from npm does not require a token.\n- Publishing requires npm authentication (for CI, set `NPM_TOKEN`; for local publishing, use [`npm login`](https://docs.npmjs.com/cli/v10/commands/npm-login)).\n","readmeFilename":"README.md"}
![](\"https://i.postimg.cc/nzVx9bmw/UIkit.jpg\")
![](\"https://i.postimg.cc/7b8SXVwd/image-4.jpg\")
\n ![](\"https://i.postimg.cc/qv0pH3RT/teleport-UI.jpg\")
\n ![](\"https://i.postimg.cc/j2FRrgL3/API.jpg\")
\n