{"id":13632698,"url":"https://github.com/mapbox/mr-ui","last_synced_at":"2025-04-18T05:32:58.086Z","repository":{"id":39625363,"uuid":"141186693","full_name":"mapbox/mr-ui","owner":"mapbox","description":"UI components for Mapbox projects","archived":false,"fork":false,"pushed_at":"2024-09-04T12:33:49.000Z","size":13308,"stargazers_count":87,"open_issues_count":16,"forks_count":8,"subscribers_count":94,"default_branch":"main","last_synced_at":"2024-10-05T19:04:35.920Z","etag":null,"topics":["frontend-shared","frontend-tooling","priority"],"latest_commit_sha":null,"homepage":"https://mapbox.github.io/mr-ui/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mapbox.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-16T19:48:38.000Z","updated_at":"2024-09-04T12:32:58.000Z","dependencies_parsed_at":"2024-01-22T22:27:26.851Z","dependency_job_id":"c776cb45-b0bf-49b5-a207-63ef42bc4715","html_url":"https://github.com/mapbox/mr-ui","commit_stats":{"total_commits":223,"total_committers":25,"mean_commits":8.92,"dds":0.7309417040358744,"last_synced_commit":"130b998ddf9aa83cba7aa8da1ebf2f48c80a35f1"},"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mapbox%2Fmr-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mapbox%2Fmr-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mapbox%2Fmr-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mapbox%2Fmr-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mapbox","download_url":"https://codeload.github.com/mapbox/mr-ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223775244,"owners_count":17200480,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["frontend-shared","frontend-tooling","priority"],"created_at":"2024-08-01T22:03:11.329Z","updated_at":"2024-11-09T01:30:40.695Z","avatar_url":"https://github.com/mapbox.png","language":"TypeScript","readme":"# @mapbox/mr-ui\n\n![mr-ui logo](https://github.com/mapbox/mr-ui/raw/main/logo/mr-ui.gif)\n\n[![Build Status](https://app.travis-ci.com/mapbox/mr-ui.svg?branch=main)](https://app.travis-ci.com/mapbox/mr-ui)\n\nPronounced `'mis-tər yü-'ī`. **M**apbox **R**eact **UI** components.\n\nUI components for Mapbox projects. See docs at https://mapbox.github.io/mr-ui/.\n\n**This project is for internal Mapbox usage.** The code is open source and we appreciate bug reports; but we will only consider feature requests and pull requests from Mapbox developers.\n\n## Installation\n\n```\nnpm install @mapbox/mr-ui\n```\n\nOn Mapbox projects, pair these components with version 1.1.0+ of Mapbox's custom [Assembly](https://labs.mapbox.com/assembly/) build. (This is not in `peerDependencies` because you might use `\u003clink\u003e` and `\u003cscript\u003e` tags instead of the npm package.)\n\nThe public Assembly build should work fine, with maybe one or two hiccups.\n\n## Usage\n\n**Import individual components!** All components are exposed at `@mapbox/mr-ui/{component-name}`. For example:\n\n```js\nimport Modal from '@mapbox/mr-ui/modal';\nimport Tooltip from '@mapbox/mr-ui/tooltip';\n```\n\nOnly the component itself and whatever *it* depends on will be drawn into your bundle.\n\n### Utility functions\n\nThere are a few utility functions you can import from `@mapbox/mr-ui/utils/{name}`.\n\nSee [the utils documentation](./src/components/utils/README.md).\n\n## Development\n\nHere are some commands you'll probably want to use:\n\n```bash\n# Start the documentation site.\nnpm start\n\n# Start Jest's CLI in watch mode.\nnpx jest --watchAll\n\n# Lint and test everything.\nnpm test\n```\n\n### Publishing\n\nThe `build` command creates a `pkg/` directory that contains the code we want to publish, organized the way we want it. So `pkg/` is the directory that we publish. `pkg/package.json` is a clone of `package.json` but with `private: true` removed.\n\n- Increment version numbers in `package.json` and `package.lock.json`, and ensure the changelog has an entry for the latest version. Then, create a new Git tag.\n- Build the `pkg/` directory: `npm run build`.\n- `cd` into the `pkg/` directory and `mbx npm publish` from there.\n- `cd` back to root and run `npm run deploy-docs` to update the docs at https://mapbox.github.io/mr-ui/\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmapbox%2Fmr-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmapbox%2Fmr-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmapbox%2Fmr-ui/lists"}