mirror of https://github.com/koreader/koreader
Added Size module
parent
9eb073a524
commit
a6be301695
@ -0,0 +1,96 @@
|
|||||||
|
--[[--
|
||||||
|
This module provides a standardized set of sizes for use in widgets.
|
||||||
|
|
||||||
|
There are values for borders, margins, paddings, radii, and lines. Have a look
|
||||||
|
at the code for full details. If you are considering to deviate from one of the
|
||||||
|
defaults, please take a second to consider:
|
||||||
|
|
||||||
|
1. Why you want to differ in the first place. We consciously strive toward
|
||||||
|
consistency in the UI, which is typically valued higher than one pixel more
|
||||||
|
or less in a specific context.
|
||||||
|
2. If there really isn't anything close to what you want, whether it should be
|
||||||
|
added to the arsenal of default sizes rather than as a local exception.
|
||||||
|
|
||||||
|
@usage
|
||||||
|
local Size = require("ui/size")
|
||||||
|
local frame -- just an example widget
|
||||||
|
frame = FrameContainer:new{
|
||||||
|
radius = Size.radius.window,
|
||||||
|
bordersize = Size.border.window,
|
||||||
|
padding = Size.padding.default,
|
||||||
|
margin = Size.margin.default,
|
||||||
|
VerticalGroup:new{
|
||||||
|
-- etc
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]]
|
||||||
|
|
||||||
|
local dbg = require("dbg")
|
||||||
|
local Screen = require("device").screen
|
||||||
|
|
||||||
|
local Size = {
|
||||||
|
border = {
|
||||||
|
default = Screen:scaleBySize(2),
|
||||||
|
thin = Screen:scaleBySize(1),
|
||||||
|
button = Screen:scaleBySize(2),
|
||||||
|
window = Screen:scaleBySize(2),
|
||||||
|
},
|
||||||
|
margin = {
|
||||||
|
default = Screen:scaleBySize(5),
|
||||||
|
tiny = Screen:scaleBySize(1),
|
||||||
|
small = Screen:scaleBySize(2),
|
||||||
|
title = Screen:scaleBySize(2),
|
||||||
|
button = 0,
|
||||||
|
},
|
||||||
|
padding = {
|
||||||
|
default = Screen:scaleBySize(5),
|
||||||
|
tiny = Screen:scaleBySize(1),
|
||||||
|
small = Screen:scaleBySize(2),
|
||||||
|
large = Screen:scaleBySize(10),
|
||||||
|
button = Screen:scaleBySize(2),
|
||||||
|
fullscreen = Screen:scaleBySize(15),
|
||||||
|
},
|
||||||
|
radius = {
|
||||||
|
default = Screen:scaleBySize(2),
|
||||||
|
window = Screen:scaleBySize(7),
|
||||||
|
button = Screen:scaleBySize(15),
|
||||||
|
},
|
||||||
|
line = {
|
||||||
|
thin = Screen:scaleBySize(0.5),
|
||||||
|
medium = Screen:scaleBySize(1),
|
||||||
|
thick = Screen:scaleBySize(1.5),
|
||||||
|
},
|
||||||
|
item = {
|
||||||
|
height_default = Screen:scaleBySize(30),
|
||||||
|
height_large = Screen:scaleBySize(50),
|
||||||
|
},
|
||||||
|
span = {
|
||||||
|
horizontal_default = Screen:scaleBySize(10),
|
||||||
|
horizontal_small = Screen:scaleBySize(5),
|
||||||
|
vertical_default = Screen:scaleBySize(2),
|
||||||
|
vertical_large = Screen:scaleBySize(5),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
if dbg.is_on then
|
||||||
|
local mt = {
|
||||||
|
__index = function(t, k)
|
||||||
|
local prop_value = rawget(t, k)
|
||||||
|
local prop_exists = prop_value ~= nil
|
||||||
|
if not prop_exists then
|
||||||
|
local warning = rawget(t, "_name") and string.format("Size.%s.%s", rawget(t, "_name"), k)
|
||||||
|
or string.format("Size.%s", k)
|
||||||
|
error("Size: this property does not exist: " .. warning)
|
||||||
|
end
|
||||||
|
assert(prop_exists)
|
||||||
|
return prop_value
|
||||||
|
end
|
||||||
|
}
|
||||||
|
setmetatable(Size, mt)
|
||||||
|
for el, table in pairs(Size) do
|
||||||
|
table._name = el
|
||||||
|
setmetatable(Size[el], mt)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
return Size
|
@ -0,0 +1,31 @@
|
|||||||
|
describe("Size module", function()
|
||||||
|
local Size
|
||||||
|
setup(function()
|
||||||
|
require("commonrequire")
|
||||||
|
Size = require("ui/size")
|
||||||
|
end)
|
||||||
|
describe("should get size", function()
|
||||||
|
it("for window border", function()
|
||||||
|
assert.is_true(Size.border.window >= 1)
|
||||||
|
end)
|
||||||
|
end)
|
||||||
|
it("should be nil for non-existent property", function()
|
||||||
|
assert.is_nil(Size.supercalifragilisticexpialidocious)
|
||||||
|
assert.is_nil(Size.border.supercalifragilisticexpialidocious)
|
||||||
|
end)
|
||||||
|
it("should fail for non-existent property when debug is activated", function()
|
||||||
|
local dbg = require("dbg")
|
||||||
|
dbg:turnOn()
|
||||||
|
Size = package.reload("ui/size")
|
||||||
|
local supercalifragilisticexpialidocious1 = function()
|
||||||
|
return Size.supercalifragilisticexpialidocious
|
||||||
|
end
|
||||||
|
local supercalifragilisticexpialidocious2 = function()
|
||||||
|
return Size.border.supercalifragilisticexpialidocious
|
||||||
|
end
|
||||||
|
|
||||||
|
assert.has_error(supercalifragilisticexpialidocious1, "Size: this property does not exist: Size.supercalifragilisticexpialidocious")
|
||||||
|
assert.has_error(supercalifragilisticexpialidocious2, "Size: this property does not exist: Size.border.supercalifragilisticexpialidocious")
|
||||||
|
dbg:turnOff()
|
||||||
|
end)
|
||||||
|
end)
|
Loading…
Reference in New Issue