{"id":23967919,"url":"https://github.com/loogle18/xray-react","last_synced_at":"2025-04-13T15:12:45.513Z","repository":{"id":48033312,"uuid":"134687537","full_name":"loogle18/xray-react","owner":"loogle18","description":"React layout debugger.","archived":false,"fork":false,"pushed_at":"2022-11-23T16:39:41.000Z","size":17609,"stargazers_count":131,"open_issues_count":6,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-13T15:12:39.974Z","etag":null,"topics":["css","debug","development","inspector","layout","react","react-component","style","ui","x-ray"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/loogle18.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-24T08:47:27.000Z","updated_at":"2025-03-31T11:37:00.000Z","dependencies_parsed_at":"2022-08-12T17:10:44.330Z","dependency_job_id":null,"html_url":"https://github.com/loogle18/xray-react","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loogle18%2Fxray-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loogle18%2Fxray-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loogle18%2Fxray-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loogle18%2Fxray-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/loogle18","download_url":"https://codeload.github.com/loogle18/xray-react/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248732487,"owners_count":21152852,"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":["css","debug","development","inspector","layout","react","react-component","style","ui","x-ray"],"created_at":"2025-01-06T23:57:01.418Z","updated_at":"2025-04-13T15:12:45.487Z","avatar_url":"https://github.com/loogle18.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# X-Ray React\nReact layout debugger inspired by [Xray-rails](https://github.com/brentd/xray-rails)\n\n#### Supported versions:\nReact: 15.x.x, 16.x.x\n\nWebpack: 2.x.x, 3.x.x, 4.x.x\n\n## Installation\n\n`npm install xray-react`\n\n## Usage\n\n#### As a plugin for webpack:\n```javascript\n// webpack.config.js\nconst { XrayReactPlugin } = require('xray-react');\n\nif(env.development) {\n    plugins.push(new XrayReactPlugin());\n}\n```\n\nEnvironment variables:\n- `XRAY_REACT_EDITOR` - path or alias for editor's exec file, which will open files on component click.\n  \n  Example:\n  ```bash\n  export XRAY_REACT_EDITOR='/Applications/Visual\\ Studio\\ Code.app/Contents/Resources/app/bin/code'\n  # or\n  export XRAY_REACT_EDITOR=code\n  ```\n\nArguments\n- `output` - (string) name of output filename. Default is **'bundle.js'** or **first available asset**.\n- `server` - (boolean) flag that specifies whether or not to run server for handling files opening on component click. Default is **true**. _If this option is set to true, please be sure you have exported 'XRAY_REACT_EDITOR' env variable, otherwise files will open in default program._\n- `sourcePath` - (string) absolute path to internal sources like components etc (e.g. `/home/user/project/client/src`). Default is **compilation context**.\n\n\n#### As a module:\n```javascript\n// index.js\nimport 'xray-react/lib/xray-react-ui';\n```\n\nPress **shift+x+r** to toggle xray-react ui\n\n![Example](media/example.gif)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floogle18%2Fxray-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floogle18%2Fxray-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floogle18%2Fxray-react/lists"}