![Community-Project](https://gitlab.com/softbutterfly/open-source/open-source-office/-/raw/master/banners/softbutterfly-open-source--banner--community-project.png)
![PyPI - Supported versions](https://img.shields.io/pypi/pyversions/wagtail-sb-structblock)
![PyPI - Package version](https://img.shields.io/pypi/v/wagtail-sb-structblock)
![PyPI - Downloads](https://img.shields.io/pypi/dm/wagtail-sb-structblock)
![PyPI - MIT License](https://img.shields.io/pypi/l/wagtail-sb-structblock)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/00f3debb1fa94a51894b03ec2273fafa)](https://app.codacy.com/gl/softbutterfly/wagtail-sb-structblock/dashboard?utm_source=gl&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/00f3debb1fa94a51894b03ec2273fafa)](https://app.codacy.com/gl/softbutterfly/wagtail-sb-structblock/dashboard?utm_source=gl&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
# Wagtail SB Struct Block
Wagtail package to render render struct block with a tabbed interface to
distinguish between content fields an settings fields in struct blocks.
## Requirements
- Python 3.8.1 or higher
- Wagtail 3.0 or higher
- Django 3.2 or higher
## Install
```bash
pip install wagtail-sb-structblock
```
## Usage
Add `wagtail_sb_structblock` to your `INSTALLED_APPS` settings
```python
INSTALLED_APPS = [
# ...
"wagtail_sb_structblock",
# ...
]
```
In your struct blocks must inherith from `StructBlock` and you must specify
the `settings_fields` ub your `Meta` class.
```python
from wagtail.blocks import StructBlock
from wagtail_sb_structblock.blocks import StructBlock
class EnhancedHTMLBlock(StructBlock):
text = CharBlock()
html_attrs = CharBlock()
class Meta:
settings_fields = [
"html_attrs",
]
```
Include it in your stream file and your model so you can use a tabed interface
for your struct block.
![content tab](https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock/-/raw/master/_assets/content_tab.png)
![settings tab](https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock/-/raw/master/_assets/settings_tab.png)
## Docs
- [Ejemplos](https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock/-/wikis)
- [Wiki](https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock/-/wikis)
## Changelog
All changes to versions of this library are listed in the [change history](CHANGELOG.md).
## Development
Check out our [contribution guide](CONTRIBUTING.md).
## Contributors
See the list of contributors [here](https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock/-/graphs/develop).
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock",
"name": "wagtail-sb-structblock",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0.0",
"maintainer_email": "",
"keywords": "Softbutterfly,Django,Migrations",
"author": "SoftButterfly Development Team",
"author_email": "dev@softbutterfly.io",
"download_url": "https://files.pythonhosted.org/packages/d5/46/c4af029e99d8309501d93b026709ef607b5211c25d735b7a30f96772b510/wagtail_sb_structblock-0.2.0.tar.gz",
"platform": null,
"description": "![Community-Project](https://gitlab.com/softbutterfly/open-source/open-source-office/-/raw/master/banners/softbutterfly-open-source--banner--community-project.png)\n\n![PyPI - Supported versions](https://img.shields.io/pypi/pyversions/wagtail-sb-structblock)\n![PyPI - Package version](https://img.shields.io/pypi/v/wagtail-sb-structblock)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/wagtail-sb-structblock)\n![PyPI - MIT License](https://img.shields.io/pypi/l/wagtail-sb-structblock)\n\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/00f3debb1fa94a51894b03ec2273fafa)](https://app.codacy.com/gl/softbutterfly/wagtail-sb-structblock/dashboard?utm_source=gl&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)\n[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/00f3debb1fa94a51894b03ec2273fafa)](https://app.codacy.com/gl/softbutterfly/wagtail-sb-structblock/dashboard?utm_source=gl&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)\n\n# Wagtail SB Struct Block\n\nWagtail package to render render struct block with a tabbed interface to\ndistinguish between content fields an settings fields in struct blocks.\n\n## Requirements\n\n- Python 3.8.1 or higher\n- Wagtail 3.0 or higher\n- Django 3.2 or higher\n\n## Install\n\n```bash\npip install wagtail-sb-structblock\n```\n\n## Usage\n\nAdd `wagtail_sb_structblock` to your `INSTALLED_APPS` settings\n\n```python\nINSTALLED_APPS = [\n # ...\n \"wagtail_sb_structblock\",\n # ...\n]\n```\n\nIn your struct blocks must inherith from `StructBlock` and you must specify\nthe `settings_fields` ub your `Meta` class.\n\n```python\nfrom wagtail.blocks import StructBlock\nfrom wagtail_sb_structblock.blocks import StructBlock\n\nclass EnhancedHTMLBlock(StructBlock):\n text = CharBlock()\n\n html_attrs = CharBlock()\n\n class Meta:\n settings_fields = [\n \"html_attrs\",\n ]\n```\n\nInclude it in your stream file and your model so you can use a tabed interface\nfor your struct block.\n\n![content tab](https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock/-/raw/master/_assets/content_tab.png)\n\n![settings tab](https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock/-/raw/master/_assets/settings_tab.png)\n\n## Docs\n\n- [Ejemplos](https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock/-/wikis)\n- [Wiki](https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock/-/wikis)\n\n## Changelog\n\nAll changes to versions of this library are listed in the [change history](CHANGELOG.md).\n\n## Development\n\nCheck out our [contribution guide](CONTRIBUTING.md).\n\n## Contributors\n\nSee the list of contributors [here](https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock/-/graphs/develop).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Social Networks settings for wagtail sites.",
"version": "0.2.0",
"project_urls": {
"Bug Tracker": "https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock/-/issues",
"Documentation": "https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock/-/wikis",
"Download": "https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock/-/archive/v0.2.0/wagtail-sb-structblock-v0.2.0.tar.gz",
"Homepage": "https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock",
"Repository": "https://gitlab.com/softbutterfly/open-source/wagtail-sb-structblock"
},
"split_keywords": [
"softbutterfly",
"django",
"migrations"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cecb54d9078a106193d858d3c2b97473b1710b29668905dd0fdeec84d7106192",
"md5": "436ed72d636de984e9069ef71f84df0a",
"sha256": "b3c22ce29e7afa007e3b827f0e9a674acaccde1184049968a5f0583a4dd9ccb7"
},
"downloads": -1,
"filename": "wagtail_sb_structblock-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "436ed72d636de984e9069ef71f84df0a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0.0",
"size": 11452,
"upload_time": "2023-09-04T05:43:42",
"upload_time_iso_8601": "2023-09-04T05:43:42.977301Z",
"url": "https://files.pythonhosted.org/packages/ce/cb/54d9078a106193d858d3c2b97473b1710b29668905dd0fdeec84d7106192/wagtail_sb_structblock-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d546c4af029e99d8309501d93b026709ef607b5211c25d735b7a30f96772b510",
"md5": "702f69305cbeb694cabb0598f4cbdcfb",
"sha256": "a05fe8436b44a3b4462762b02ee41bfebf9f050122b20a20d8d5eb4754cfeacf"
},
"downloads": -1,
"filename": "wagtail_sb_structblock-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "702f69305cbeb694cabb0598f4cbdcfb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0.0",
"size": 9660,
"upload_time": "2023-09-04T05:43:45",
"upload_time_iso_8601": "2023-09-04T05:43:45.284205Z",
"url": "https://files.pythonhosted.org/packages/d5/46/c4af029e99d8309501d93b026709ef607b5211c25d735b7a30f96772b510/wagtail_sb_structblock-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-04 05:43:45",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "softbutterfly",
"gitlab_project": "open-source",
"lcname": "wagtail-sb-structblock"
}