lala/list-style

Last activity 14 Apr 2021 1
composer require lala/list-style

Neos Package that adds the option to change the list-style of uls and ols.

dev-master

Version
dev-master
Type
neos-package
Release Date
Apr 14, 2021 11:04
Source
git
Distribution
zip
Requires
MIT
  • #list
  • #neos
  • #neos-ui
  • #list-style
6a0c134cc2d7c8100783a6e588816a521bdd9be2

Lala.ListStyle

Neos Package that adds the option to change the list-style of uls and ols.

Warning

This package is WIP.

Please keep the following caveats in mind:

  • This plugin does not support adding classes to the lists. Instead, it will add an attribute list-style-type="circle" to the list
  • When changing the style of a list, the complete list has to be selected in the editor, otherwise the list will be split up into multiple lists with different styles
  • It is not possible to allow only a subset of the configured styles per property
  • Does not work for ordered lists (yet)

Installation

composer require lala/list-style:dev-master

Usage

  1. Enable formatting for a property:
'Neos.Demo:Content.Text':
  superTypes:
    'Neos.Neos:Content': true
    'Neos.NodeTypes.BaseMixins:TextMixin': true

  properties:
    text:
      ui:
        inline:
          editorOptions:
            formatting:
              # Enable unordered lists
              ul: true
              # Enable custom list styles
              listStyle: true
  1. Create a list in the editor
  2. Select the whole using the cursor
  3. Open the dropdown and change the list style

Styling

Please note that this plugin does not supply list styles on it's own.

There is a ListStyles.css file in Resources/Public that you can include if needed:

prototype(Neos.Neos:Page) {
    head.stylesheets {
        listStyles = Neos.Fusion:Component {
            href = Neos.Fusion:ResourceUri {
                path = 'resource://Lala.ListStyle/Public/ListStyles.css'
            }

            renderer = afx`
                <link rel="stylesheet" href={props.href} media="all" />
            `
        }
    }
}

Customization

The available list styles can be customized through the Settings:

Lala:
  ListStyle:
    styles:
      ul:
        default:
          value: ''
          title: 'Default'
        circle:
          value: 'neos-list-circle'
          title: 'Circle'
        square:
          value: 'neos-list-square'
          title: 'Square'

        # To disable styles, set them to NULL
        # square: ~

The title is used as the button label in the backend, the value will be the value of the list-style-type attribute of the list. Make sure to add styling for your custom list styles.

The content of the readme is provided by Github
The same vendor provides 3 package(s).