{"id":15415253,"url":"https://github.com/jaredpalmer/squeezy","last_synced_at":"2025-04-19T13:42:22.048Z","repository":{"id":57368490,"uuid":"113063895","full_name":"jaredpalmer/squeezy","owner":"jaredpalmer","description":"1 kB React component for accessible accordions / collapse UI","archived":false,"fork":false,"pushed_at":"2017-12-04T16:13:57.000Z","size":56,"stargazers_count":29,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-29T08:22:17.516Z","etag":null,"topics":["accordion","react","render-props"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/jaredpalmer.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":"2017-12-04T16:03:03.000Z","updated_at":"2025-02-11T15:49:57.000Z","dependencies_parsed_at":"2022-09-05T19:20:28.422Z","dependency_job_id":null,"html_url":"https://github.com/jaredpalmer/squeezy","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredpalmer%2Fsqueezy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredpalmer%2Fsqueezy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredpalmer%2Fsqueezy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredpalmer%2Fsqueezy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaredpalmer","download_url":"https://codeload.github.com/jaredpalmer/squeezy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249705105,"owners_count":21313283,"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":["accordion","react","render-props"],"created_at":"2024-10-01T17:07:42.478Z","updated_at":"2025-04-19T13:42:22.016Z","avatar_url":"https://github.com/jaredpalmer.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Squeezy\n\nAn tiny 1KB React component for accessible accordions / collapse UI\n\n```\nnpm i squeezy\n```\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n- [Usage](#usage)\n- [API](#api)\n  - [`\u003cSqueezy\u003e` Props](#squeezy-props)\n    - [`id: string`](#id-string)\n    - [`debug?: boolean`](#debug-boolean)\n    - [`isOpen?: boolean`](#isopen-boolean)\n    - [`onToggle?: (state: SqueezyState, helpers: SqueezyActions) =\u003e void`](#ontoggle-state-squeezystate-helpers-squeezyactions--void)\n    - [`render: (props: SqueezyProps) =\u003e React.ReactNode`](#render-props-squeezyprops--reactreactnode)\n  - [Squeezy State and Helpers](#squeezy-state-and-helpers)\n    - [`getButtonProps(moreProps: any) =\u003e void`](#getbuttonpropsmoreprops-any--void)\n    - [`getContentProps(moreProps: any) =\u003e void`](#getcontentpropsmoreprops-any--void)\n    - [`isOpen: boolean`](#isopen-boolean)\n    - [`close: () =\u003e void`](#close---void)\n    - [`open: () =\u003e void`](#open---void)\n    - [`toggle: () =\u003e void`](#toggle---void)\n- [Inspiration](#inspiration)\n- [Author](#author)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Usage\n\n```js\nimport React from 'react';\nimport { Squeezy } from 'squeezy';\n\nconst App = () =\u003e (\n  \u003cdiv\u003e\n    \u003ch1\u003eMy App\u003c/h1\u003e\n\n    \u003cSqueezy\n      id=\"thing\"\n      render={({ getButtonProps, getContentProps, isOpen }) =\u003e (\n        \u003cdiv\u003e\n          \u003cdiv\u003e\n            Stuff\n            \u003cbutton {...getButtonProps({ className: 'whatever' })}\u003e\n              See {isOpen ? 'more' : 'less'}\n            \u003c/button\u003e\n          \u003c/div\u003e\n\n          {isOpen ? (\n            \u003cdiv {...getContentProps({ className: '...' })}\u003eStuff to show\u003c/div\u003e\n          ) : null}\n        \u003c/div\u003e\n      )}\n    /\u003e\n  \u003c/div\u003e\n);\n\nexport default App;\n```\n\n## API\n\n### `\u003cSqueezy\u003e` Props\n\n#### `id: string`\n\n**Required**\n\nAn HTML `id` attribute. Used by Squeezy to make the accordion accessible.\n\n#### `debug?: boolean`\n\nLog changes to Squeezy state to the console.\n\n#### `isOpen?: boolean`\n\nIf you want to make Squeezy a controlled component (i.e. manage its state\nexternally), pass Squeezy an `isOpen` prop.\n\n#### `onToggle?: (state: SqueezyState, helpers: SqueezyActions) =\u003e void`\n\nCallback to run on state changes. If Squeezy is controlled, use this to set the\nnext state externally. Otherwise, good place for side effects.\n\n#### `render: (props: SqueezyProps) =\u003e React.ReactNode`\n\nRender prop.\n\n### Squeezy State and Helpers\n\n#### `getButtonProps(moreProps: any) =\u003e void`\n\nProp getter that returns accessible accordion button props and click handlers\n\n#### `getContentProps(moreProps: any) =\u003e void`\n\nProp getter that returns accessible accordion content props. Spread this on the\nbody / main area that you want show/hide\n\n#### `isOpen: boolean`\n\nIs the accordion open or close.\n\n#### `close: () =\u003e void`\n\nClose the accordion.\n\n#### `open: () =\u003e void`\n\nOpen the accordion.\n\n#### `toggle: () =\u003e void`\n\nToggle the accordion.\n\n## Inspiration\n\n* [react-toggled](https://github.com/kentcdodds/react-toggled)\n\n## Author\n\n* Jared Palmer ([@jaredpalmer](https://twitter.com/jaredpalmer))\n\n---\n\nMIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaredpalmer%2Fsqueezy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaredpalmer%2Fsqueezy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaredpalmer%2Fsqueezy/lists"}