{ "manifest": { "name": "@patternfly/react-table", "version": "5.4.16", "description": "This library provides a set of React table components for use with the PatternFly 4", "main": "dist/js/index.js", "module": "dist/esm/index.js", "types": "dist/esm/index.d.ts", "typesVersions": { "*": { "deprecated": [ "dist/esm/deprecated/index.d.ts" ] } }, "patternfly:src": "src/", "sideEffects": false, "publishConfig": { "access": "public" }, "repository": { "type": "git", "url": "https://github.com/patternfly/patternfly-react.git" }, "keywords": [ "react", "patternfly", "table" ], "author": { "name": "Red Hat" }, "license": "MIT", "bugs": { "url": "https://github.com/patternfly/patternfly-react/issues" }, "homepage": "https://github.com/patternfly/patternfly-react/tree/main/packages/react-table#readme", "scripts": { "build:umd": "rollup -c --environment IS_PRODUCTION", "build:single:packages": "node ../../scripts/build-single-packages.js --config single-packages.config.json", "clean": "rimraf dist components deprecated", "subpaths": "node ../../scripts/exportSubpaths.js --config subpaths.config.json" }, "dependencies": { "@patternfly/react-core": "^5.4.14", "@patternfly/react-icons": "^5.4.2", "@patternfly/react-styles": "^5.4.1", "@patternfly/react-tokens": "^5.4.1", "lodash": "^4.17.21", "tslib": "^2.7.0" }, "peerDependencies": { "react": "^17 || ^18", "react-dom": "^17 || ^18" }, "gitHead": "2aa38ef2a1cb4889c35e98c0a74576351488f901", "_registry": "npm", "_loc": "/home/josie/.cache/yarn/v6/npm-@patternfly-react-table-5.4.16-3197db7cf7cc3a2f721bbb8adb0fb7ca9182f5fc-integrity/node_modules/@patternfly/react-table/package.json", "readmeFilename": "README.md", "readme": "# @patternfly/react-table\n\nThis package provides Table PatternFly components based on [PatternFly][patternfly]\n\n### Installing\n\n```sh\nyarn add @patternfly/react-table\n```\n\nor\n\n```sh\nnpm install @patternfly/react-table --save\n```\n\n## Usage\n\nIt's strongly advised to use the PatternFly base CSS in your whole project, or some components may diverge in appearance:\n\n```js\nimport '@patternfly/react-core/dist/styles/base.css';\n```\n\n#### Example component usage\n\n```js\nimport { Table, Thead, Tr, Th, Td, Tbody } from '@patternfly/react-table';\n\nexport const ComposableTableBasic = () => {\n const repositories = [\n { name: 'one', branches: 'two', prs: 'three' },\n { name: 'one - 2', branches: null, prs: null },\n { name: 'one - 3', branches: 'two - 3', prs: 'three - 3' }\n ];\n\n const columnNames = {\n name: 'Repositories',\n branches: 'Branches',\n prs: 'Pull requests'\n };\n \n return (\n \n \n \n \n \n \n \n \n \n {repositories.map(repo => (\n \n \n \n \n \n ))}\n \n
{columnNames.name}{columnNames.branches}{columnNames.prs}
{repo.name}{repo.branches}{repo.prs}
\n );\n}\nexport default SimpleTable;\n```\n\n## Contribution\n\nThis library makes use of the babel plugin from [@patternfly/react-styles](../react-styles/README.md) to enable providing the CSS alongside the components. This removes the need for consumers to use (style|css|sass)-loaders. For an example of using CSS from core you can reference [Button.js](./src/components/Button/Button.js). For any CSS not provided by core please use the `StyleSheet.create` utility from [@patternfly/react-styles](../react-styles/README.md). This will prevent collisions with any consumers, and allow the CSS to be bundled with the component.\n\n### Documentation\n\nA comprehensive list of components and detailed usage of each can be found on the [PatternFly react docs][docs] website\nYou can also find how each component is meant to be used from a design perspective on the [PatternFly core][patternfly] website.\n\nNote: All commands below assume you are on the root directory in this repository.\n\n### Install & run locally\n\nRun to install all the dependencies, build and run the site locally.\n\n```sh\nyarn install && yarn start\n```\n\n### Testing\n\nTesting is done at the root of this repo. To only run the @patternfly/react-table tests:\n\n```\nyarn test packages/react-table\n```\n\n[patternfly]: https://github.com/patternfly/patternfly\n[docs]: https://react-staging.patternfly.org/\n", "licenseText": "MIT License\n\nCopyright (c) 2019 Red Hat, Inc.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, "artifacts": [], "remote": { "resolved": "https://registry.yarnpkg.com/@patternfly/react-table/-/react-table-5.4.16.tgz#3197db7cf7cc3a2f721bbb8adb0fb7ca9182f5fc", "type": "tarball", "reference": "https://registry.yarnpkg.com/@patternfly/react-table/-/react-table-5.4.16.tgz", "hash": "3197db7cf7cc3a2f721bbb8adb0fb7ca9182f5fc", "integrity": "sha512-K/xNdTvFKFyD6WhuBU/GCq/3LTrSaObdXSTmzefWWcPcN0gcf/J3ouiuapj951JIsP13CMmwJBNtEa3aHR8igg==", "registry": "npm", "packageName": "@patternfly/react-table", "cacheIntegrity": "sha512-K/xNdTvFKFyD6WhuBU/GCq/3LTrSaObdXSTmzefWWcPcN0gcf/J3ouiuapj951JIsP13CMmwJBNtEa3aHR8igg== sha1-MZfbfPfMOi9yG7uK2w+3ypGC9fw=" }, "registry": "npm", "hash": "3197db7cf7cc3a2f721bbb8adb0fb7ca9182f5fc" }