Interface

ListPropertiesStyleConfig (list)

@ckeditor/ckeditor5-list/src/listconfig

interface

Filtering

Properties

  • listStyleTypes : ListStyleTypesConfig | undefined

    Defines which list styles should be available in the UI. Accepts a configuration object with numbered and bulleted styles.

    {
      list: {
        properties: {
          styles: {
            listStyleTypes: {
              numbered: [ 'decimal', 'lower-roman', 'upper-roman' ],
              bulleted: [ 'disc', 'circle' ]
            }
          }
        }
      }
    }
    

    When the listTypes configuration is set, listStyleTypes will only take effect for the enabled list types. For example, with the following configuration:

    {
      list: {
        properties: {
          styles: {
            listTypes: 'numbered',
            listStyleTypes: {
              numbered: [ 'decimal', 'lower-roman' ],
              bulleted: [ 'disc', 'circle' ]
            }
          }
        }
      }
    }
    

    Only the numbered list styles will be available in the UI, as the listTypes property limits style selection to numbered lists only.

    Note: This configuration works only with list properties.

    Defaults to `{ numbered: [ 'decimal', 'decimal-leading-zero', 'lower-roman', 'upper-roman', 'lower-latin', 'upper-latin' ], bulleted: [ 'disc', 'circle', 'square' ] }`

  • listTypes : ArrayOrItem<ListPropertiesStyleListType> | undefined

    Enable style feature for the given list type only.

    {
    	list: {
    		properties: {
    			styles: {
    				listTypes: 'numbered'
    			}
    
    			// ...
    		}
    	},
    
    	// ...
    }
    

    Note: This configuration works only with list properties.

    Defaults to ['bulleted','numbered']

  • useAttribute : boolean | undefined

    When set true, the list style feature will use the type attribute of <ul> and <ol> elements instead of the list-style-type style.

    {
    	list: {
    		properties: {
    			styles: {
    				useAttribute: true
    			},
    
    			// ...
    		}
    	},
    
    	// ...
    }
    

    Note: Due to limitations of HTML, the "Decimal with leading zero" style is impossible to set using the type attribute.

    Note: This configuration works only with list properties.

    Defaults to false