{"id":15064963,"url":"https://github.com/davidde/gatsby-theme-simpwa","last_synced_at":"2025-07-20T17:04:05.621Z","repository":{"id":36620363,"uuid":"202024894","full_name":"davidde/gatsby-theme-simpwa","owner":"davidde","description":"Configurable template for building simple PWA's","archived":false,"fork":false,"pushed_at":"2023-05-06T13:43:57.000Z","size":2035,"stargazers_count":5,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-20T17:02:47.709Z","etag":null,"topics":["gatsby-theme","gatsbyjs","pwa","react","sidebar","sidebar-theme"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/gatsby-theme-simpwa","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/davidde.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-12T23:33:29.000Z","updated_at":"2023-11-20T02:39:12.000Z","dependencies_parsed_at":"2024-10-13T00:41:25.830Z","dependency_job_id":"c4528437-cb24-4b44-9c84-ace0d7a9aeb2","html_url":"https://github.com/davidde/gatsby-theme-simpwa","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/davidde/gatsby-theme-simpwa","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidde%2Fgatsby-theme-simpwa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidde%2Fgatsby-theme-simpwa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidde%2Fgatsby-theme-simpwa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidde%2Fgatsby-theme-simpwa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davidde","download_url":"https://codeload.github.com/davidde/gatsby-theme-simpwa/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidde%2Fgatsby-theme-simpwa/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266161900,"owners_count":23885927,"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":["gatsby-theme","gatsbyjs","pwa","react","sidebar","sidebar-theme"],"created_at":"2024-09-25T00:28:42.281Z","updated_at":"2025-07-20T17:04:05.602Z","avatar_url":"https://github.com/davidde.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gatsby theme for simple PWA's\nThis theme provides a generic, re-usable and modular layout for developing simple\n[PWA's](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps)\nwith responsive left/right sidebars.\nThe intended use case is for **simple web apps** aiming to present themselves as close\nas possible to native mobile apps. The idea here is that a simple app can stuff all\nits content in the main screen and its sidebars.\n\n### Priorities:\n- Single codebase for both desktop and mobile\n- PWA experience comparable to native apps\n- Touch-friendly: sidebars should respond to swiping\n- Responsive design: should work on any viewport size\n- Simple sidebar design: see [minimal implementation](https://github.com/davidde/sidebars)\n\n### How it looks:\n- [Deployed theme starter](https://davidde.github.io/gatsby-starter-simpwa/)\n([source code](https://github.com/davidde/gatsby-starter-simpwa))\n\n# Installation\n* Create a new project based on\n  [this theme's starter](https://github.com/davidde/gatsby-starter-simpwa):\n  ```bash\n  gatsby new my-app https://github.com/davidde/gatsby-starter-simpwa\n  cd my-app\n  gatsby develop\n  ```\n\n* **Or** install the theme to an existing project and configure it:\n  ```bash\n  npm install gatsby-theme-simpwa\n  ```\n  Then, in your gatsby-config.js, add the theme to your plugins,\n  and override the default PWA manifest options:\n  ```js\n  module.exports = {\n    plugins: [\n      {\n        resolve: 'gatsby-theme-simpwa',\n        options: {\n          name: 'my-app',\n          short_name: 'my-app',\n          start_url: '/',\n          background_color: '#663399',\n          theme_color: '#663399',\n          display: 'standalone',\n          icon: 'src/images/icon.png', // This path is relative to the root of the site.\n        },\n      },\n    ],\n  }\n  ```\n\n# Usage\nThe theme provides 4 main components to build your app; a parent `\u003cLayout\u003e`\ncomponent, and its 3 children, `\u003cLeftside\u003e`, `\u003cMainView\u003e` and `\u003cRightside\u003e`.\nSince the sidebar implementation relies on flexbox, it is important to specify\nthe child components in that exact source order (left to right),\nalthough either of the sidebars can be omitted.\n\nSimply import them into your code to start building:\n```js\nimport { Layout, MainView, Leftside, Rightside } from 'gatsby-theme-simpwa';\n```\n\n## \\\u003cLayout\u003e component\nThe parent component that enables its 3 children components to work properly.\n\n*Optional* props:\n  - **theme**: The theme to use for your app: 'light', 'dark' or 'joy'. Defaults to 'light'.\n  - **leftActive**: *Bool* (not string) indicating whether the left sidebar\n    should be active on first load. Defaults to true.\n  - **rightActive**: *Bool* (not string) indicating whether the right sidebar\n    should be active on first load. Defaults to true.\n  - **mutex**: *Bool* indicating whether the sidebars should mutually\n    exclude each other from being active. Defaults to false.\n  - **sidestrip**: String indicating the status of the small hoverable strip\n  at the edge of the screen:  \n  'on', 'hidden', 'off', 'off-touchscreens'. Defaults to 'off-touchscreens'.\n\n**NOTE:**  \nThe Layout component's props are initialisation props.\nThey will not trigger a rerender on subsequent updates, since they are immediately written to state.\n\n## \\\u003cLeftside\u003e and \\\u003cRightside\u003e components\nThe **left and right sidebars** of your app. Should be direct descendants of `\u003cLayout\u003e`, and Leftside\nshould be specified first in source order (before MainView), and Rightside last (after MainView).\nEither can be omitted if you only want a single sidebar.\n\nProps:\n  - **header**: The header of the sidebar.\n  - **icon**: Font Awesome icon from `@fortawesome/free-solid-svg-icons`\n    that triggers the sidebar.\n\n## \\\u003cMainView\u003e component\nThe main content of your app. Should be a direct descendant of `\u003cLayout\u003e`, and specified second in\nsource order (after Leftside).\n\nProps:\n  - **header**: The header of your app.\n\n\n# Customization\nCustomization is fairly simple due to a modular approach to styling/theming.\n\n\u003e Even the theme 's got themes!\n\nThese subthemes are defined in the `_vars.scss` partial in `src/components/main/`.  \nYou can shadow this file together with the main `layout.scss` and modify the subtheme variables,\nor create your own subthemes altogether!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidde%2Fgatsby-theme-simpwa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavidde%2Fgatsby-theme-simpwa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidde%2Fgatsby-theme-simpwa/lists"}