{"_id":"@adamstankiewicz/openedxfrontend-slot-footer","name":"@adamstankiewicz/openedxfrontend-slot-footer","dist-tags":{"latest":"1.1.0"},"versions":{"1.1.0":{"name":"@adamstankiewicz/openedxfrontend-slot-footer","version":"1.1.0","description":"Site footer PluginSlot utilizing Frontend Plugin Framework","main":"dist/index.js","repository":{"type":"git","url":"git+https://github.com/openedx/frontend-slot-footer.git"},"browserslist":["extends @edx/browserslist-config"],"scripts":{"build":"make build","lint":"fedx-scripts eslint --ext .js --ext .jsx --ext .ts --ext .tsx .","lint:fix":"fedx-scripts eslint --fix --ext .js --ext .jsx --ext .ts --ext .tsx .","snapshot":"fedx-scripts jest --updateSnapshot","test":"fedx-scripts jest --coverage --passWithNoTests"},"husky":{"hooks":{"pre-commit":"npm run lint"}},"author":{"name":"Open edX Community"},"license":"AGPL-3.0","homepage":"https://github.com/openedx/frontend-slot-footer#readme","publishConfig":{"access":"public"},"bugs":{"url":"https://github.com/openedx/frontend-slot-footer/issues"},"dependencies":{"@openedx/frontend-plugin-framework":"^1.1.2"},"peerDependencies":{"@edx/frontend-component-footer":"*","react":"^17.0.0 || ^18.0.0"},"devDependencies":{"@edx/frontend-component-footer":"npm:@adamstankiewicz/openedx-frontend-component-footer@^14.0.0","@edx/browserslist-config":"^1.1.1","@openedx/frontend-build":"npm:@adamstankiewicz/openedx-frontend-build@^14.0.3","core-js":"3.40.0","glob":"7.2.3","husky":"7.0.4","jest":"29.7.0","react":"^18.0.0"},"_id":"@adamstankiewicz/openedxfrontend-slot-footer@1.1.0","gitHead":"f6e82622b07b07679140d6def1330a597608508c","_nodeVersion":"20.17.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-hUdKWh9RJERXnxgPj95h3UckSICfYaDd4Q7h8BiyOTwXFq16aXAXMse/hAN767YHe227evcMB7G4LICe2aq3Sg==","shasum":"78017be67f1ba802e227f14920b9b47d4d35eb9d","tarball":"https://registry.npmjs.org/@adamstankiewicz/openedxfrontend-slot-footer/-/openedxfrontend-slot-footer-1.1.0.tgz","fileCount":8,"unpackedSize":39961,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCyiNz9FFRVri0X9E6jnaU7g1nVyQjBuKidil7mAnT2HQIgbwRncK00UYpQ+Vt+pStO1bCHepm1CXhlPMGGrdEKTds="}]},"_npmUser":{"name":"adamstankiewicz","email":"agstanki@gmail.com"},"directories":{},"maintainers":[{"name":"adamstankiewicz","email":"agstanki@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/openedxfrontend-slot-footer_1.1.0_1739342080297_0.8225711105488396"},"_hasShrinkwrap":false}},"time":{"created":"2025-02-12T06:34:40.182Z","1.1.0":"2025-02-12T06:34:40.576Z","modified":"2025-02-12T06:34:40.886Z"},"maintainers":[{"name":"adamstankiewicz","email":"agstanki@gmail.com"}],"description":"Site footer PluginSlot utilizing Frontend Plugin Framework","homepage":"https://github.com/openedx/frontend-slot-footer#readme","repository":{"type":"git","url":"git+https://github.com/openedx/frontend-slot-footer.git"},"author":{"name":"Open edX Community"},"bugs":{"url":"https://github.com/openedx/frontend-slot-footer/issues"},"license":"AGPL-3.0","readme":"# frontend-slot-footer\n\nThis package provides a wrapped version of the footer using [Frontend Plugin Framework](https://github.com/openedx/frontend-plugin-framework).\n\n### Slot ID: `footer_slot`\n\n## Description\n\nThis slot is used to replace/modify/hide the footer.\n\n## Example\n\nThe following `env.config.jsx` will replace the default footer.\n\n![Screenshot of Default Footer](./docs/images/default_footer.png)\n\nwith a simple custom footer\n\n![Screenshot of Custom Footer](./docs/images/custom_footer.png)\n\n```js\nimport { DIRECT_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';\n\nconst config = {\n  pluginSlots: {\n    footer_slot: {\n      plugins: [\n        {\n          // Hide the default footer\n          op: PLUGIN_OPERATIONS.Hide,\n          widgetId: 'default_contents',\n        },\n        {\n          // Insert a custom footer\n          op: PLUGIN_OPERATIONS.Insert,\n          widget: {\n            id: 'custom_footer',\n            type: DIRECT_PLUGIN,\n            RenderWidget: () => (\n              <h1 style={{textAlign: 'center'}}>🦶</h1>\n            ),\n          },\n        },\n      ]\n    }\n  },\n}\n\nexport default config;\n```\n","readmeFilename":"README.md"}