root
API
Generated with
root/play/play.api/play.api.i18n

play.api.i18n

package play.api.i18n

Contains the internationalisation API.

For example, translating a message:

val msgString = Messages("items.found", items.size)

Attributes

Members list

Type members

Classlikes

@Singleton
class DefaultLangs(val availables: Seq[Lang]) extends Langs

Attributes

Supertypes
trait Langs
class Object
trait Matchable
class Any
@Singleton
class DefaultLangsProvider(config: Configuration) extends Provider[Langs]

Attributes

Supertypes
trait Provider[Langs]
class Object
trait Matchable
class Any
@Singleton
class DefaultMessagesApi(val messages: Map[String, Map[String, String]], langs: Langs, val langCookieName: String, val langCookieSecure: Boolean, val langCookieHttpOnly: Boolean, val langCookieSameSite: Option[SameSite], val httpConfiguration: HttpConfiguration, val langCookieMaxAge: Option[Int]) extends MessagesApi

The Messages API.

The Messages API.

Attributes

Supertypes
trait MessagesApi
class Object
trait Matchable
class Any
@Singleton
class DefaultMessagesApiProvider(environment: Environment, config: Configuration, langs: Langs, httpConfiguration: HttpConfiguration) extends Provider[MessagesApi]

Attributes

Supertypes
trait Provider[MessagesApi]
class Object
trait Matchable
class Any
trait I18NSupportLowPriorityImplicits

Implicit conversions for using i18n with requests and results.

Implicit conversions for using i18n with requests and results.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait I18nSupport
object I18nSupport.type
trait I18nComponents

Injection helper for i18n components

Injection helper for i18n components

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class I18nModule extends Module

Attributes

Supertypes
class Module
class Object
trait Matchable
class Any
trait I18nSupport extends I18NSupportLowPriorityImplicits

Brings convenient implicit conversions from play.api.mvc.RequestHeader to Messages.

Brings convenient implicit conversions from play.api.mvc.RequestHeader to Messages.

Example:

 import play.api.i18n.Messages
 class MyController(val messagesApi: MessagesApi ...)
   extends AbstractController(cc) with I18nSupport {
   val action = Action { implicit request =>
     val messageFromRequest = request.messages("hello.world")
     Ok(s"$messageFromRequest")
   }
 }

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object I18nSupport extends I18NSupportLowPriorityImplicits

A static object with type enrichment for request and responses.

A static object with type enrichment for request and responses.

import I18nSupport._

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class Lang(locale: Locale)

A Lang supported by the application.

A Lang supported by the application.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Lang

Utilities related to Lang values.

Utilities related to Lang values.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Lang.type
trait LangImplicits

A trait for extracting a Messages instance from Langs

A trait for extracting a Messages instance from Langs

Attributes

Supertypes
class Object
trait Matchable
class Any
trait Langs

Manages languages in Play

Manages languages in Play

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class DefaultLangs
object Messages extends MessagesImplicits

Internationalisation API.

Internationalisation API.

For example:

val msgString = Messages("items.found", items.size)

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Messages.type
trait Messages extends MessagesProvider

A messages returns string messages using a chosen language.

A messages returns string messages using a chosen language.

This is commonly backed by a MessagesImpl case class, but does extend Product and does not expose MessagesApi as part of its interface.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class MessagesImpl
trait MessagesApi

The internationalisation API.

The internationalisation API.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class MessagesImpl(lang: Lang, messagesApi: MessagesApi) extends Messages

Provides messages for a particular language.

Provides messages for a particular language.

This intended for use to carry both the messages and the current language, particularly useful in templates so that both can be captured by one parameter.

Value parameters

lang

The lang (context)

messagesApi

The messages API

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Messages
class Object
trait Matchable
class Any
Show all
trait MessagesImplicits

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Messages.type
trait MessagesProvider

This trait is used to indicate when a Messages instance can be produced.

This trait is used to indicate when a Messages instance can be produced.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Messages
class MessagesImpl
class MessagesRequest[A]
Generated with