{"id":22025705,"url":"https://github.com/dwango-js/react-toggle-pattern","last_synced_at":"2025-10-25T02:37:49.692Z","repository":{"id":57346555,"uuid":"59034815","full_name":"dwango-js/react-toggle-pattern","owner":"dwango-js","description":"React Component that provide toggle pattern","archived":false,"fork":false,"pushed_at":"2018-09-16T07:57:54.000Z","size":70,"stargazers_count":16,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-27T09:04:03.141Z","etag":null,"topics":["component","react"],"latest_commit_sha":null,"homepage":null,"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/dwango-js.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":"2016-05-17T15:27:47.000Z","updated_at":"2023-12-27T03:21:11.000Z","dependencies_parsed_at":"2022-09-11T16:32:08.750Z","dependency_job_id":null,"html_url":"https://github.com/dwango-js/react-toggle-pattern","commit_stats":null,"previous_names":["azu/react-toggle-pattern"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dwango-js%2Freact-toggle-pattern","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dwango-js%2Freact-toggle-pattern/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dwango-js%2Freact-toggle-pattern/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dwango-js%2Freact-toggle-pattern/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dwango-js","download_url":"https://codeload.github.com/dwango-js/react-toggle-pattern/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252851776,"owners_count":21814212,"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":["component","react"],"created_at":"2024-11-30T07:19:06.199Z","updated_at":"2025-10-25T02:37:49.600Z","avatar_url":"https://github.com/dwango-js.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-toggle-pattern [![Build Status](https://travis-ci.org/dwango-js/react-toggle-pattern.svg?branch=master)](https://travis-ci.org/dwango-js/react-toggle-pattern)\n\nReact Component that provide toggle pattern\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n    npm install react-toggle-pattern\n\n## Usage\n\n`react-toggle-pattern` provide three components.\n\n### Insert and Remove pattens\n\n- `\u003cTogglePattern /\u003e` or pattern. This is same with `\u003cToggleOrPattern /\u003e`\n- `\u003cToggleOrPattern /\u003e` or pattern\n- `\u003cToggleAndPattern /\u003e` and pattern\n\nPut `\u003cYourComponent /\u003e` into `\u003cTogglePattern /\u003e`.\n\n```js\nimport {TogglePattern} from \"react-toggle-pattern\";\nclass ToggleButton extends React.Component {\n    render(){\n        return (\n            \u003cTogglePattern isEditing={this.props.isEditing}\u003e\n                \u003cLeaveEditingButton isEditing={true} /\u003e\n                \u003cEnterEditingButton isEditing={false} /\u003e\n            \u003c/TogglePattern\u003e\n        );\n    }\n}\n```\n\nIt means that\n\n- if `this.props.isEditing` is `true`, show `\u003cLeaveEditingButton /\u003e`\n- if `this.props.isEditing` is `false`, show `\u003cEnterEditingButton /\u003e`\n- In the other case, show `null`\n\n### `\u003cTogglePattern /\u003e` Interface\n\n- `\u003cTogglePattern anyAttribute=anyValue /\u003e`\n    - `anyAttribute` is any name.\n    - `anyValue` is any type.\n\n`\u003cToggleOrPattern /\u003e` and `\u003cToggleAndPattern /\u003e` has same interface.\n\n### OR AND pattern\n\n#### OR\n\n`\u003cToggleOrPattern /\u003e` filter child components by **OR** matching.\n\n- find component that match with `a` is `true` or `b` is `false`.\n\n```js\n\u003cToggleOrPattern a={true}\u003e\n    \u003cLeaveEditingButton a={true} b={false} /\u003e\n    \u003cEnterEditingButton a={true} /\u003e\n\u003c/ToggleOrPattern\u003e\n```\n\nResult to: \n\n```html\n\u003cdiv class=\"TogglePattern ToggleOrPattern\"\u003e\n    \u003cLeaveEditingButton a={true} b={false} /\u003e\n    \u003cEnterEditingButton a={true} /\u003e\n\u003c/div\u003e\n```\n\nBoth components are **or** match with TogglePattern.\n\n#### AND\n\n`\u003cToggleAndPattern /\u003e` filter child components by **AND** matching.\n\n- find component that match with `a` is `true` and `b` is `false`.\n\n```js\n\u003cToggleAndPattern a={true} b={false}\u003e\n    \u003cLeaveEditingButton a={true} b={false} /\u003e\n    \u003cEnterEditingButton a={true} /\u003e\n\u003c/ToggleAndPattern\u003e\n```\n\nResult to:\n\n```html\n\u003cLeaveEditingButton a={true} b={false} /\u003e\n```\n\n`\u003cEnterEditingButton /\u003e` is not **and** match with TogglePattern.\n\n### Example\n\nShow component that has truly attribute with `\u003cTogglePattern attribute /\u003e`\n\n```js\nconst TogglePattern = require(\"react-toggle-pattern\").TogglePattern;\n// render\n\u003cTogglePattern isEditing={true}\u003e\n    \u003cComponentX isEditing/\u003e\n    \u003cComponentY /\u003e\n\u003c/TogglePattern\u003e\n```\n\nResult to `\u003cComponentX /\u003e`\n\n----\n\nShow component that match attribute and value with `\u003cTogglePattern attribute=value /\u003e`\n\n```js\n\u003cTogglePattern isEditing={false}\u003e\n    \u003cComponentX isEditing={true} /\u003e\n    \u003cComponentY isEditing={false} /\u003e\n\u003c/TogglePattern\u003e\n```\n\nResult to `\u003cComponentY /\u003e`\n\nAlso, it is ok that `value` it `string` type.\n\n```js\n\u003cTogglePattern pattern=\"one\"\u003e\n    \u003cComponentX pattern=\"one\"/\u003e\n    \u003cComponentY pattern=\"two\"/\u003e\n\u003c/TogglePattern\u003e\n```\n\nResult to `\u003cComponentY /\u003e`\n\n-----\n\nShow component**s** that match attribute and value with `\u003cTogglePattern attribute=value /\u003e`.\n\n```js\n\u003cTogglePattern isEditing={true}\u003e\n    \u003cComponentX isEditing={true} /\u003e\n    \u003cComponentX isEditing={true}/\u003e\n\u003c/TogglePattern\u003e\n```\n\nResult to `\u003cdiv class=\"TogglePattern ToggleOrPattern\"\u003e\u003cComponentX /\u003e\u003cComponentX /\u003e\u003c/div\u003e`\n\n-----\n\nNot show when not match\n\n```js\n\u003cTogglePattern isEditing={false}\u003e\n    \u003cComponentX isEditing={true} /\u003e\n    \u003cComponentY /\u003e\n\u003c/TogglePattern\u003e\n```\n\nResult to `null`.\n\n------\n\nOR match\n\n```js\n\u003cToggleOrPattern pattern1={1} pattern2={2}\u003e\n    \u003cComponentX pattern1={1} pattern2={2}/\u003e\n    \u003cComponentY pattern1={1}/\u003e\n\u003c/ToggleOrPattern\u003e\n```\n\nResult to `\u003cdiv class=\"TogglePattern ToggleOrPattern\"\u003e\u003cdiv\u003eVisible\u003c/div\u003e\u003cdiv\u003eHidden\u003c/div\u003e\u003c/div\u003e`.\n\n------\n\nAnd match\n\n```js\n\u003cToggleAndPattern pattern1={1} pattern2={2}\u003e\n    \u003cComponentX pattern1={1} pattern2={2}/\u003e\n    \u003cComponentY pattern1={1} /\u003e\n\u003c/ToggleAndPattern\u003e\n```\n\nResult to `\u003cComponentX pattern1={1} pattern2={2}/\u003e`.\n\n\n### Show and Hide pattern\n\nIt is an experimental pattern.\n\n- `\u003cToggleAndDisplayPattern /\u003e`\n\nIt has same interface `\u003cToggleAndPattern /\u003e`, but it has difference logic.\n\n- It use `hidden` attribute for non-showing element.\n    - You should add `[hidden]{ display: none!important; };` to own css.\n- It always wrapped children components with `\u003cdiv class=\"ToggleAndDisplayPattern\"\u003e{children}\u003c/ToggleAndDisplayPattern\u003e`\n\n**Props**\n\n- `\u003cToggleAndDisplayPattern /\u003e` try to preserve your focus.\n    - `\u003cToggleAndPattern /\u003e` missing focus because of inserting and removing.\n\n**Cons**\n\n- Automatically wrap `{this.props.children}` with `div` element.\n\n## Changelog\n\nSee [Releases page](https://github.com/dwango-js/react-toggle-pattern/releases).\n\n## Running tests\n\nInstall devDependencies and Run `npm test`:\n\n    npm i -d \u0026\u0026 npm test\n\n## Contributing\n\nPull requests and stars are always welcome.\nFor bugs and feature requests, [please create an issue](https://github.com/dwango-js/react-toggle-pattern/issues).\n\n1. Fork it!\n2. Create your feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. Submit a pull request :D\n\n## Author\n\n- [github/azu](https://github.com/azu)\n- [twitter/azu_re](http://twitter.com/azu_re)\n\n## License\n\nMIT © azu\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdwango-js%2Freact-toggle-pattern","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdwango-js%2Freact-toggle-pattern","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdwango-js%2Freact-toggle-pattern/lists"}