Here you’ll find reference documentation for Liferay DXP, Liferay Screens, Liferay Faces, and technologies related to you as a third-party developer.
The different types of reference docs you’ll find in this section are as follows:
- Descriptions of Java and JavaScript APIs, CSS, tags and tag libraries, and XML DTDs
- Write ups on the latest Screenlets for Liferay Screens
- Breaking changes
- Cheat sheets and tips on
- Plugin anatomy
- Design patterns
- Tools
- Adapting to new APIs
Liferay’s reference docs are at your fingertips.
Java APIs
Here you’ll find Javadoc for Liferay DXP 7.1 and Liferay DXP apps.
Liferay DXP 7.1 Java APIs
Core: | com.liferay.portal.kernel (portal-kernel): (Opens New Window) for developing applications on Liferay DXP |
---|---|
com.liferay.util.bridges (util-bridges): (Opens New Window) for using various non-proprietary computing languages, frameworks, and utilities on Liferay DXP | |
com.liferay.util.java (util-java): (Opens New Window) for using various Java-related frameworks and utilities on Liferay DXP | |
com.liferay.util.slf4j (util-slf4j): (Opens New Window) for using the Simple Logging Facade for Java (SLF4J) | |
com.liferay.portal.impl (portal-impl): (Opens New Window) refer to this only if you are an advanced Liferay developer that needs a deeper understanding of Liferay DXP 7.1's implementation in order to contribute to it |
Liferay DXP App Java APIs
This table links you to Liferay DXP application APIs. Their root location is here.
App | Packages |
---|---|
Announcements: | com.liferay.announcements.constants |
Apio Architect: | com.liferay.apio.architect.api |
Application List: | com.liferay.application.list.api com.liferay.application.list.taglib |
Asset: | com.liferay.asset.api com.liferay.asset.categories.navigation.api com.liferay.asset.category.property.api com.liferay.asset.display.api com.liferay.asset.display.page.api com.liferay.asset.display.page.item.selector.api com.liferay.asset.entry.rel.api com.liferay.asset.publisher.api com.liferay.asset.tag.stats.api com.liferay.asset.taglib com.liferay.asset.tags.api com.liferay.asset.tags.navigation.api com.liferay.asset.test.util |
Blogs: | com.liferay.blogs.api com.liferay.blogs.demo.data.creator.api com.liferay.blogs.item.selector.api com.liferay.blogs.recent.bloggers.api com.liferay.blogs.test.util |
Calendar: | com.liferay.calendar.api |
Captcha: | com.liferay.captcha.api com.liferay.captcha.taglib |
Comment: | com.liferay.comment.api com.liferay.comment.demo.data.creator.api com.liferay.comment.taglib |
Configuration Admin: | com.liferay.configuration.admin.api |
Contacts: | com.liferay.contacts.api |
Document Library: | com.liferay.document.library.api com.liferay.document.library.content.api com.liferay.document.library.demo.data.creator.api com.liferay.document.library.file.rank.api com.liferay.document.library.repository.authorization.api com.liferay.document.library.repository.cmis.api com.liferay.document.library.repository.external.api com.liferay.document.library.sync.api com.liferay.document.library.test.util |
Dynamic Data Lists: | com.liferay.dynamic.data.lists.api |
Dynamic Data Mapping: | com.liferay.dynamic.data.mapping.api com.liferay.dynamic.data.mapping.taglib com.liferay.dynamic.data.mapping.test.util |
Export Import: | com.liferay.exportimport.api com.liferay.exportimport.changeset.api com.liferay.exportimport.changeset.taglib com.liferay.exportimport.test.util |
Flags: | com.liferay.flags.api com.liferay.flags.taglib |
Fragment: | com.liferay.fragment.api com.liferay.fragment.demo.data.creator.api com.liferay.fragment.item.selector.api |
Friendly URL: | com.liferay.friendly.url.api |
Frontend Editor: | com.liferay.frontend.editor.api |
Frontend Image Editor: | com.liferay.frontend.image.editor.capability |
Frontend JS: | com.liferay.frontend.js.loader.modules.extender.npm |
HTML Preview: | com.liferay.html.preview.api |
Invitation: | com.liferay.invitation.invite.members.api |
Item Selector: | com.liferay.item.selector.api com.liferay.item.selector.criteria.api com.liferay.item.selector.taglib |
Journal: | com.liferay.journal.api com.liferay.journal.content.asset.addon.entry.api com.liferay.journal.demo.data.creator.api com.liferay.journal.item.selector.api com.liferay.journal.taglib com.liferay.journal.test.util |
Layout: | com.liferay.layout.api com.liferay.layout.admin.api com.liferay.layout.item.selector.api com.liferay.layout.page.template.api com.liferay.layout.prototype.api com.liferay.layout.set.prototype.api com.liferay.layout.taglib |
Map: | com.liferay.map.api com.liferay.map.taglib |
Mentions: | com.liferay.mentions.api |
Message Boards: | com.liferay.message.boards.api com.liferay.message.boards.demo.data.creator.api com.liferay.message.boards.test.util |
Mobile Device Rules: | com.liferay.mobile.device.rules.api |
Organizations: | com.liferay.organizations.api com.liferay.organizations.item.selector.api |
Password Policies Admin: | com.liferay.password.policies.admin.constants |
Polls: | com.liferay.polls.api |
Portal: | com.liferay.portal.custom.jsp.bag.api com.liferay.portal.dao.orm.custom.sql.api com.liferay.portal.instance.lifecycle.api com.liferay.portal.jmx.api com.liferay.portal.output.stream.container.api com.liferay.portal.spring.extender.api com.liferay.portal.upgrade.api |
Portal Background Task: | com.liferay.portal.background.task.api |
Portal Cache: | com.liferay.portal.cache.api com.liferay.portal.cache.ehcache.spi com.liferay.portal.cache.test.util |
Portal Configuration: | com.liferay.portal.configuration.test.util com.liferay.portal.configuration.upgrade.api |
Portal Instances: | com.liferay.portal.instances.service |
Portal Lock: | com.liferay.portal.lock.api |
Portal Reports Engine: | com.liferay.portal.reports.engine.api |
Portal Remote: | com.liferay.portal.remote.soap.extender |
Portal Rules: | com.liferay.portal.rules.engine |
Portal Scripting: | com.liferay.portal.scripting |
Portal Search: | com.liferay.portal.search.api com.liferay.portal.search.engine.adapter.api com.liferay.portal.search.spi com.liferay.portal.search.test.util com.liferay.portal.search.web.api |
Portal Security: | com.liferay.portal.security.exportimport.api com.liferay.portal.security.ldap.api com.liferay.portal.security.permission.api com.liferay.portal.security.service.access.policy.api com.liferay.portal.security.service.access.quota.api |
Portal Security Audit: | com.liferay.portal.security.audit.api com.liferay.portal.security.audit.event.generators.api com.liferay.portal.security.audit.storage.api |
Portal Security SSO: | com.liferay.portal.security.sso.cas.api com.liferay.portal.security.sso.facebook.connect.api com.liferay.portal.security.sso.google.api com.liferay.portal.security.sso.ntlm.api com.liferay.portal.security.sso.openid.api com.liferay.portal.security.sso.openid.connect.api com.liferay.portal.security.sso.opensso.api com.liferay.portal.security.sso.token.api |
Portal Settings: | com.liferay.portal.settings.api |
Portal Template: | com.liferay.portal.template.soy.api |
Portal URL Builder: | com.liferay.portal.url.builder |
Portal Workflow: | com.liferay.portal.workflow.api com.liferay.portal.workflow.kaleo.api com.liferay.portal.workflow.kaleo.definition.api com.liferay.portal.workflow.kaleo.runtime.api |
Portlet Display Template: | com.liferay.portlet.display.template.api |
Product Navigation: | com.liferay.product.navigation.control.menu.api com.liferay.product.navigation.product.menu.api com.liferay.product.navigation.simulation.api com.liferay.product.navigation.taglib |
Ratings: | com.liferay.ratings.page.ratings.constants |
Reading Time: | com.liferay.reading.time.api com.liferay.reading.time.taglib |
Roles: | com.liferay.roles.admin.api com.liferay.roles.admin.demo.data.creator.api com.liferay.roles.item.selector.api |
RSS: | com.liferay.rss.api com.liferay.rss.taglib |
Site: | com.liferay.site.api com.liferay.site.demo.data.creator.api com.liferay.site.item.selector.api com.liferay.site.taglib |
Social: | com.liferay.social.activities.api com.liferay.social.activities.taglib com.liferay.social.activity.api com.liferay.social.activity.test.util com.liferay.social.bookmarks.api com.liferay.social.bookmarks.taglib com.liferay.social.user.statistics.api |
Staging: | com.liferay.staging.api com.liferay.staging.taglib |
Subscription: | com.liferay.subscription.api |
Text Localizer: | com.liferay.text.localizer.address.api com.liferay.text.localizer.taglib |
Trash: | com.liferay.trash.api com.liferay.trash.taglib com.liferay.trash.test.util |
Upload: | com.liferay.upload |
User Associated Data: | com.liferay.user.associated.data.api com.liferay.user.associated.data.test.util |
User Groups Admin: | com.liferay.user.groups.admin.api com.liferay.user.groups.admin.item.selector.api |
Users Admin: | com.liferay.users.admin.api com.liferay.users.admin.demo.data.creator.api com.liferay.users.admin.item.selector.api com.liferay.users.admin.test.util |
Wiki: | com.liferay.wiki.api |
XStream: | com.liferay.xstream.configurator |
For help finding module attributes and configuring dependencies, see Configuring Dependencies.
Taglibs
Here you’ll find tag library documentation for the Liferay DXP 7.1, Liferay DXP apps, and Liferay Faces.
Liferay DXP 7.1 Taglibs
Util Taglibs (Opens New Window) | JSTL core |
---|---|
aui | |
liferay-portlet | |
portlet | |
portlet_1_0 | |
liferay-security | |
liferay-theme | |
liferay-ui | |
liferay-util |
Liferay DXP App Taglibs
Adaptive Media: | liferay-application-list (Opens New Window) |
---|---|
Application List: | liferay-application-list (Opens New Window) |
Assets: | liferay-asset (Opens New Window) |
liferay-trash (Opens New Window) | |
Forms: | liferay-ddm (Opens New Window) |
Foundation: | liferay-map (Opens New Window) |
liferay-frontend (Opens New Window) | |
Import, Export, & Staging: | liferay-staging (Opens New Window) |
Item Selector: | liferay-item-selector (Opens New Window) |
Product Navigation: | liferay-product-navigation (Opens New Window) |
Sites: | liferay-layout (Opens New Window) |
liferay-site-navigation (Opens New Window) | |
Social: | liferay-flags (Opens New Window) |
For help finding module attributes and configuring dependencies, see Configuring Dependencies.
Faces Taglibs
Faces 3.2 Taglibs: the latest version of Liferay Faces JSF tag docs in View Declaration Language (VDL) format. VDL docs for all versions of Liferay Faces are available here.
JavaScript and CSS
Lexicon: A system for building applications in and outside of Liferay DXP, designed to be fluid and extensible, as well as provide a consistent and documented API.
Clay: The web implementation of Liferay’s Lexicon Experience Language.
Bootstrap: The base CSS library onto which Lexicon is built. Liferay DXP uses Bootstrap natively and all of its CSS classes and JavaScript features are available within portlets, templates, and themes.
AlloyUI: Liferay includes AlloyUI and all of its JavaScript APIs are available within portlets, templates and themes.
Descriptor Definitions
DTDs: Describes the XML files used in configuring Liferay DXP apps, Liferay DXP plugins, and Liferay DXP 7.1.