{"id":13452110,"url":"https://github.com/Tripwire/octagon","last_synced_at":"2025-03-23T19:33:43.459Z","repository":{"id":57342005,"uuid":"77168631","full_name":"Tripwire/octagon","owner":"Tripwire","description":"Semantic-UI-React Themed Component Library","archived":true,"fork":false,"pushed_at":"2019-03-19T09:24:53.000Z","size":41202,"stargazers_count":18,"open_issues_count":14,"forks_count":8,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-10-06T18:18:11.098Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://tripwire.github.io/octagon","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tripwire.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-22T18:55:45.000Z","updated_at":"2023-01-28T13:14:16.000Z","dependencies_parsed_at":"2022-09-13T02:22:21.247Z","dependency_job_id":null,"html_url":"https://github.com/Tripwire/octagon","commit_stats":null,"previous_names":[],"tags_count":111,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tripwire%2Foctagon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tripwire%2Foctagon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tripwire%2Foctagon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tripwire%2Foctagon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tripwire","download_url":"https://codeload.github.com/Tripwire/octagon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221900726,"owners_count":16898986,"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":[],"created_at":"2024-07-31T07:01:13.315Z","updated_at":"2024-10-28T18:30:38.798Z","avatar_url":"https://github.com/Tripwire.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# octagon\n\n\u003cimg src=\"https://raw.githubusercontent.com/Tripwire/octagon/master/img/octagon.png\" height=\"80px\" /\u003e\n\n[![CircleCI](https://circleci.com/gh/Tripwire/octagon.svg?style=svg)](https://circleci.com/gh/Tripwire/octagon) ![](https://img.shields.io/badge/standardjs-%E2%9C%93-brightgreen.svg) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![Greenkeeper badge](https://badges.greenkeeper.io/Tripwire/octagon.svg)](https://greenkeeper.io/)\n\n\n\u003cimg src=\"https://raw.githubusercontent.com/Tripwire/octagon/master/img/octagon-styleguide.gif\" width=\"50%\" /\u003e\n\n## description\n\noctagon is a react component library. it is built on top of Semantic UI React (SUIR). You can see examples of the components and tinker with the API via our [interactive library documentation](https://tripwire.github.io/octagon/)**.\n\nthis package provides:\n\n- a custom semantic-ui theme\n- a set of supplementary react components beyond those provided by SUIR\n\n _note: if you are looking for a ground up framework, please instead jump directly to [semantic-ui-react](http://react.semantic-ui.com/), as this project is generally just an opionionated implementation of the SUI ecosystem._\n\n## installation\n\nto install and use this project within your project, simply clone the react-octagon project and use yarn to install it.\n\n`yarn add react-octagon` or `yarn add --dev react-octagon`\n\n## usage\n\nusing octagon components in your app is easy:\n\n- import octagon's CSS\n- import components from the lib, or from SUIR\n\n```js\nimport 'react-octagon/lib/styles/semantic.css'\nimport { FavoriteButton } from 'react-octagon'\nimport { Segment } from 'semantic-ui-react'\n\nclass MyWigdet () {\n  render () {\n    return (\n      \u003cSegment\u003e\n        \u003cFavoriteButton isFavorited /\u003e\n      \u003c/Segment\u003e\n    )\n  }\n}\n```\n\nyou can interact with octagon components on our [interactive styleguide](https://tripwire.github.io/octagon/). you can also [launch this locally](#starting-the-environment), which will be especially valuable if you want to develop new components. built on [Styleguidist](https://github.com/styleguidist/react-styleguidist).\n\n### react component api distribution\n\n**useful** if you've `yarn link`ed your front-end project with `octagon` and want to iterate on components without suffering the build/publish lifecycle for `octagon`.  you must run `yarn build` to get a fresh set of react components!\n\n## contributing\n\nplease see [CONTRIBUTING.md](CONTRIBUTING.md) for all development.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTripwire%2Foctagon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTripwire%2Foctagon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTripwire%2Foctagon/lists"}