{{newin|[[0.9.2]]|092|type=module}}

This library provides basic support for handling UTF-8 encoded strings. 

It provides all its functions inside the table returned by <code>require("utf8")</code>. This library does not provide any support for Unicode other than handling UTF-8 encoding. Any operation that needs the meaning of a character, such as character classification, is outside its scope.

For detailed usage, see the [http://www.lua.org/manual/5.3/manual.html#6.5 reference manual].

{{notice|The utf8.char function does not work correctly in [[0.9.2]]; However, it is not an issue since [[0.10.0]]}}


== Examples ==
Print text the user writes, and erase it using the UTF-8 module.
<source lang="lua">
local utf8 = require("utf8")

function love.load()
    text = "Type away! -- "

    -- enable key repeat so backspace can be held down to trigger love.keypressed multiple times.
    love.keyboard.setKeyRepeat(true)
end

function love.textinput(t)
    text = text .. t
end

function love.keypressed(key)
    if key == "backspace" then
        -- get the byte offset to the last UTF-8 character in the string.
        local byteoffset = utf8.offset(text, -1)

        if byteoffset then
            -- remove the last UTF-8 character.
            -- string.sub operates on bytes rather than UTF-8 characters, so we couldn't do string.sub(text, 1, -2).
            text = string.sub(text, 1, byteoffset - 1)
        end
    end
end

function love.draw()
    love.graphics.printf(text, 0, 0, love.graphics.getWidth())
end
</source>

== See Also ==
* [[parent::love]]
* [[love.textinput]]

[[Category:Libraries]]
{{#set:Description=Provides basic support for manipulating UTF-8 strings.}}
{{#set:LOVE Version=0.9.2}}
{{#set:Keyword=String}}
== Other Languages ==
{{i18n|utf8}}