New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

EZP-29998 As a developer, I want to define icons for Content Types #520

Merged

MagdalenaZuba merged 5 commits into master from custom_content_type_icons

Feb 1, 2019

Contributor

MagdalenaZuba commented Jan 30, 2019

Question	Answer
JIRA Ticket	ezsystems/ezplatform-admin-ui#804 (comment)
Versions	master


          Custom Content Type icons

d2666e5

MagdalenaZuba added Needs DOC review Needs DEV review labels

MagdalenaZuba requested a review from adamwojs

January 30, 2019 15:49

adamwojs requested changes

View reviewed changes

Member

adamwojs left a comment •

edited

Loading

Two missing notes:

Icons should be in SVG format (at least for the admin siteaccesses)
Configuration is siteaccess aware

docs/guide/extending_ez_platform.md Outdated


		### Configuration

		A configuration of the default icon for Content Type is possible via default-config key.

Member

adamwojs Jan 30, 2019

Suggested change

      
            A configuration of the default icon for Content Type is possible via default-config key.
          
            A configuration of the default icon for Content Type is possible via `default-config` key.

docs/guide/extending_ez_platform.md Outdated

+                               thumbnail: '/assets/images/mydefaulticon.svg'
+              ```
+              Configuration of a custom icon will be exactly the same, you just need to replace default-config key with a custom one.

Member

adamwojs Jan 30, 2019

Suggested change

      
            Configuration of a custom icon will be exactly the same, you just need to replace default-config key with a custom one.
          
            Configuration of a custom icon will be exactly the same, you just need to replace default-config key with a content type identifier.

docs/guide/extending_ez_platform.md Outdated

+              ### Custom icons in Twig templates
+              Content Type icons are accessible in Twig templates via `ez_content_type_icon` function.
+              It requires Content Type or Content Type Identifier as an argument. Function returns path to a Content Type icon.

Member

adamwojs Jan 30, 2019

Suggested change

      
            It requires Content Type or Content Type Identifier as an argument. Function returns path to a Content Type icon.
          
            It requires Content Type Identifier as an argument. Function returns path to a Content Type icon.

docs/guide/extending_ez_platform.md Outdated

+              </svg>
+              ```
+              If the icon for given Content Type is not specified in the configuration then path to the default icon will be returned.

Member

adamwojs Jan 30, 2019

Suggested change

      
            If the icon for given Content Type is not specified in the configuration then path to the default icon will be returned.
          
            If the icon for given Content Type is not specified in the configuration then default icon will be returned.

docs/guide/extending_ez_platform.md Outdated

+                  system:
+                     default:
+                         content_type:
+                            default-config:

Member

adamwojs Jan 30, 2019

Suggested change

      
                          default-config:
          
                          article:

adamwojs requested a review from tischsoic

January 30, 2019 20:06

tischsoic reviewed

View reviewed changes

docs/guide/extending_ez_platform.md

+                      <use xlinkHref={contentTypeIcon} />
+                  </svg>
+              );
+              ```

Contributor

tischsoic Jan 31, 2019 •

edited

Loading

I would rewrite this part to something like:
(more or less, I'm bad writer, so you can change if you feel that something is not smooth :) )

Content Types icons configuration is stored in global object: eZ.adminUiConfig.contentTypes.

You can easily retrieve icon url with helper function getContentTypeIconUrl(contentTypeIdentifier), set on global object eZ.helpers.contentType. It takes Content Type Identifier as an argument and returns url of given content type's icon or null in case there is no content type with given identifier.

Example:

const contentTypeIconUrl = eZ.helpers.contentType.getContentTypeIconUrl(contentTypeIdentifier);
return (
   <svg className="ez-icon">
       <use xlinkHref={contentTypeIconUrl} />
   </svg>
);


          corrections after review

3c6f60d

DominikaK suggested changes

View reviewed changes

docs/guide/extending_ez_platform.md Outdated

               }
               ```
+              ## Custom Content Type icons
+              To add custom icons for existing Content Types or custom Content Types in eZ Platform follow below instruction.

Contributor

DominikaK Feb 1, 2019

Suggested change

      
            To add custom icons for existing Content Types or custom Content Types in eZ Platform follow below instruction.
          
            To add custom icons for existing Content Types or custom Content Types in eZ Platform follow the instructions below.

docs/guide/extending_ez_platform.md Outdated

+                               thumbnail: '/assets/images/mydefaulticon.svg'
+              ```
+              Configuration of a custom icon will be exactly the same, you just need to replace default-config key with a Content Type identifier.

Contributor

DominikaK Feb 1, 2019

Suggested change

      
            Configuration of a custom icon will be exactly the same, you just need to replace default-config key with a Content Type identifier.
          
            Configuration of a custom icon will be exactly the same, you just need to replace the `default-config` key with a Content Type identifier.

docs/guide/extending_ez_platform.md Outdated

+              ### Custom icons in Twig templates
+              Content Type icons are accessible in Twig templates via `ez_content_type_icon` function.
+              It requires Content Type identifier as an argument. Function returns path to a Content Type icon.

Contributor

DominikaK Feb 1, 2019

Suggested change

      
            It requires Content Type identifier as an argument. Function returns path to a Content Type icon.
          
            It requires Content Type identifier as an argument. The function returns the path to a Content Type icon.

docs/guide/extending_ez_platform.md Outdated


		Example with `getContentTypeIcon`:

		```React JSX

Contributor

DominikaK Feb 1, 2019

React jsx is not recognised as a language and breaks rendering. jsx might work.

tischsoic approved these changes

View reviewed changes

MagdalenaZuba added 2 commits

February 1, 2019 08:56


          corrections after review

9c67931


          corrections after review

96f86ab

DominikaK approved these changes

View reviewed changes


          corrections after review

4f1c8df

MagdalenaZuba removed the Needs DOC review label

adamwojs approved these changes

View reviewed changes

MagdalenaZuba added Ready for MERGE and removed Needs DEV review labels

MagdalenaZuba merged commit 99f21b0 into master

MagdalenaZuba deleted the custom_content_type_icons branch

February 1, 2019 10:07

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Ready for MERGE