You are here

Home » API reference » Paragraphs Sets 8

README.txt in Paragraphs Sets 8

Same filename and directory in other branches
  1. 8.2 README.txt
-- SUMMARY --

The "Paragraphs Sets" module allows to create sets of paragraphs added to an
entity by default or selected while creating the entity.


-- REQUIREMENTS --

Obviously you'll need to install the "Paragraphs" module.


-- INSTALLATION --

Install as usual, see
https://www.drupal.org/documentation/install/modules-themes/modules-8 for
further information.


-- WIDGETS --

"Paragraphs Sets" currently provides one widget in addition to "Paragraphs".

  * "Paragraphs Classic (sets)": like "Paragraphs Classic" but with the option
    to configure a default set and select the paragraphs set on entity creation.


-- CONFIGURATION EXAMPLES --

There is no UI (yet?) for creating paragraph sets so you have to create the
config entities manually. Setting default values is limited (and tested only)
for primitive field types. Setting complex field values requires implementing
hook_paragraphs_set_data_alter(). See paragraphs_sets.api.php for all hooks.

  * Create a set containing a single paragraph of type "text":
    <code>
    id: ps_example_text
    label: 'Simple text (empty)'
    description: 'Simple text paragraph without values'
    paragraphs:
      -
        type: text
        data: {  }
    </code>
  * Create a set containing multiple paragraphs with default values:
    <code>
    id: ps_example_text_multiple
    label: 'Multiple paragraphs'
    description: 'Multiple paragraphs with default values'
    paragraphs:
      -
        type: text
        data:
          field_headline: 'First item'
          field_content: '<p>You may add HTML, too!</p>'
      -
        type: text_with_image
        data:
          field_headline: 'Second item'
      -
        type: text
        data:
          field_content: '<p>This is another text paragraph.</p>'
    </code>


-- CONTACT --

Current maintainers:
* Stefan Borchert (stborchert) - http://drupal.org/user/36942

This project has been sponsored by:

  * undpaul
    Drupal experts providing professional Drupal development services.
    Visit http://www.undpaul.de for more information.

File

README.txt
View source 
  1. -- SUMMARY --

  2. 

  3. The "Paragraphs Sets" module allows to create sets of paragraphs added to an

  4. entity by default or selected while creating the entity.

  5. 

  6. 

  7. -- REQUIREMENTS --

  8. 

  9. Obviously you'll need to install the "Paragraphs" module.

  10. 

  11. 

  12. -- INSTALLATION --

  13. 

  14. Install as usual, see

  15. https://www.drupal.org/documentation/install/modules-themes/modules-8 for

  16. further information.

  17. 

  18. 

  19. -- WIDGETS --

  20. 

  21. "Paragraphs Sets" currently provides one widget in addition to "Paragraphs".

  22. 

  23.   * "Paragraphs Classic (sets)": like "Paragraphs Classic" but with the option

  24.     to configure a default set and select the paragraphs set on entity creation.

  25. 

  26. 

  27. -- CONFIGURATION EXAMPLES --

  28. 

  29. There is no UI (yet?) for creating paragraph sets so you have to create the

  30. config entities manually. Setting default values is limited (and tested only)

  31. for primitive field types. Setting complex field values requires implementing

  32. hook_paragraphs_set_data_alter(). See paragraphs_sets.api.php for all hooks.

  33. 

  34.   * Create a set containing a single paragraph of type "text":

  35.     

  36.     id: ps_example_text

  37.     label: 'Simple text (empty)'

  38.     description: 'Simple text paragraph without values'

  39.     paragraphs:

  40.       -

  41.         type: text

  42.         data: {  }

  43.     

  44.   * Create a set containing multiple paragraphs with default values:

  45.     

  46.     id: ps_example_text_multiple

  47.     label: 'Multiple paragraphs'

  48.     description: 'Multiple paragraphs with default values'

  49.     paragraphs:

  50.       -

  51.         type: text

  52.         data:

  53.           field_headline: 'First item'

  54.           field_content: '
    You may add HTML, too!
    '

  55.       -

  56.         type: text_with_image

  57.         data:

  58.           field_headline: 'Second item'

  59.       -

  60.         type: text

  61.         data:

  62.           field_content: '
    This is another text paragraph.
    '

  63.     

  64. 

  65. 

  66. -- CONTACT --

  67. 

  68. Current maintainers:

  69. * Stefan Borchert (stborchert) - http://drupal.org/user/36942

  70. 

  71. This project has been sponsored by:

  72. 

  73.   * undpaul

  74.     Drupal experts providing professional Drupal development services.

  75.     Visit http://www.undpaul.de for more information.