Skip to content

Commit 18bd1ac

Browse files
NPCRayNPCRay
authored
polario-frame:1.0.0 (#3473)
1 parent bd336b5 commit 18bd1ac

17 files changed

+681
-0
lines changed

‎packages/preview/polario-frame/1.0.0/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [2025] [Ray]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎packages/preview/polario-frame/1.0.0/README.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
## Polario Frame
2+
**`polario-frame`** is an easy-to-use photo frame package for Typst. It provides multiple themes and image cropping utilities to create your photo frames. `polario` is derived from **Polaroid**, reflecting the aspiration for this tool to deliver desired photos as quickly as a Polaroid camera.
3+
4+
## Simple Usage
5+
1. Import the `polario-frame` package:
6+
7+
```typst
8+
#import "@preview/polario-frame:1.0.0": *
9+
```
10+
11+
2. Use the crop utility to crop the image:
12+
13+
```typst
14+
#let img = crop(bytes(read("simple.jpg", encoding: none)), start: (25%, 25%), resize: 75%)
15+
```
16+
17+
3. Use `polario-frame` to render the photo frame:
18+
19+
```typst
20+
#let ext-info = (
21+
"first": image("logo/apple.svg"),
22+
"second": text(size: 22pt)[This is the title],
23+
"third": text(size: 8pt)[Kunming\ Lijiang],
24+
"extend-middle-ratio": 65%,
25+
"background": rgb("#ffffffee"),
26+
)
27+
#render((width, height), flipped: false, theme: "classic-bottom-three", img: img, ext-info: ext-info)
28+
```
29+
30+
This makes it easy to add the `classic-bottom-three` frame to the photo.
31+
32+
Rendering result
33+
![A page displaying the same photograph with four different frames, showing the camera settings, brand and the date in different styles](https://raw.githubusercontent.com/NPCRay/polario-frame/bca5fb6752e4784827d455ada1442364c0f43d37/example/example.png)
34+
35+
If you need other theme frames, check the [example](https://github.com/NPCRay/photo-frame/blob/master/example). It contains default themes, custom themes, and examples of popular smartphone brand frames. If you find that the basic themes don't cover your needs, please submit an issue or PR.
36+
37+
## Basic Theme Parameters
38+
### Render Parameters
39+
- `size`: Can be passed as a tuple like `(width, height)`, or standard paper names like `A1`~`A11`
40+
- `flipped`: Whether to flip, default is false
41+
- `theme`: Frame theme, available values `classic-bottom-two` `classic-bottom-three` `classic-right-two` `classic-right-three` `polaroid-bottom-two` `polaroid-bottom-three` `polaroid-right-two` `polaroid-right-three`
42+
- `img`: Image, should be cropped before passing
43+
- `ext-info`: Frame extended information, determined according to theme
44+
45+
### Supported ext-info Properties
46+
- `first`: The first element from left to right or top to bottom, empty by default
47+
- `second`: The second element from left to right or top to bottom, empty by default
48+
- `third`: The third element from left to right or top to bottom, empty by default (only supported by *-three themes)
49+
- `extend-ratio`: Extended white border width ratio, default 10%
50+
- `extend-half-ratio`: Extended white border first element ratio, default 50% (only supported by *-two themes)
51+
- `extend-middle-ratio`: Extended middle element ratio, default 20% (only supported by *-three themes)
52+
- `background`: Background color, none by default
53+
- `inset-ratio`: Padding ratio, no inset by default 3% (only supported by polaroid-* themes)
54+
55+
## Versions
56+
57+
### 1.0.0
58+
- Official version
59+
- Provides 8 basic theme styles `classic-bottom-two` `classic-bottom-three` `classic-right-two` `classic-right-three` `polaroid-bottom-two` `polaroid-bottom-three` `polaroid-right-two` `polaroid-right-three` frames
60+
- Provides cropping tool `crop`
61+
- Added more examples in example folder
62+
63+
### 0.1.0
64+
- Initial release

‎packages/preview/polario-frame/1.0.0/README_CN.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
## Polario 相框
2+
**`polario-frame`** 是一个易于使用的 Typst 相框包。它提供了多种主题和图像裁剪工具来制作您的相框。`polario` 源自 **Polaroid**（拍立得），体现了本工具希望像拍立得相机一样快速呈现理想照片的愿望。
3+
4+
5+
## 简单使用
6+
1. 通过以下方式导入 `polario-frame` 包：
7+
8+
```typst
9+
#import "@preview/polario-frame:1.0.0": *
10+
```
11+
12+
2. 使用裁剪工具裁剪图片：
13+
14+
```typst
15+
#let img = crop(bytes(read("simple.jpg", encoding: none)), start: (25%, 25%), resize: 75%)
16+
```
17+
18+
3. 使用 `polario-frame` 渲染相框：
19+
20+
```typst
21+
#let ext-info = (
22+
"first": image("logo/apple.svg"),
23+
"second": text(size: 22pt)[这是标题],
24+
"third": text(size: 8pt)[昆明\ 丽江],
25+
"extend-middle-ratio": 65%,
26+
"background": rgb("#ffffffee"),
27+
)
28+
#render((width, height), flipped: false, theme: "classic-bottom-three", img: img, ext-info: ext-info)
29+
```
30+
31+
这样可以轻松地为照片添加 `classic-bottom-three` 相框。
32+
33+
渲染效果
34+
35+
![显示同一张照片的四个不同相框，展示不同风格的相机设置、品牌和日期](https://raw.githubusercontent.com/NPCRay/polario-frame/bca5fb6752e4784827d455ada1442364c0f43d37/example/example.png)
36+
37+
如果您需要其他主题相框，可以查看 [exmaple](https://github.com/NPCRay/photo-frame/blob/master/example)。 里面包含了默认主题，自定义主题，以及现在常见的各个手机品牌的相框样例。如果发现基本主题没有覆盖到，请提 issue 或者 PR。
38+
39+
## 基础主题参数
40+
### 渲染参数
41+
- `size`: 可以传入一个元组，如 `(width, height)`, 或者传标准纸名称，如 `A1`~`A11`
42+
- `flipped`: 是否翻转，默认false
43+
- `theme`: 相框主题，可选值 `classic-bottom-two` `classic-bottom-three` `classic-right-two` `classic-right-three` `polaroid-bottom-two` `polaroid-bottom-three` `polaroid-right-two` `polaroid-right-three`
44+
- `img`: 图片，传之前需先裁剪
45+
- `ext-info`: 相框扩展信息，具体根据主题决定
46+
47+
### ext-info 支持的属性
48+
- `first`: 从左到右或者从上到下的第一个元素, 默认空
49+
- `second`: 从左到右或者从上到下的第二个元素, 默认空
50+
- `third`:从左到右或者从上到下的第三个元素, 默认空 (仅 *-three 主题支持)
51+
- `extend-ratio`: 扩展白边宽度比例，默认10%
52+
- `extend-half-ratio`: 扩展白边第一个元素比例，默认50% (仅 *-two 主题支持)
53+
- `extend-middle-ratio`: 扩展中间元素比例，默认20% (仅 *-three 主题支持)
54+
- `background`:背景颜色，默认无
55+
- `inset-ratio`: 内边距比例，默认不连边 3%(仅 polaroid-* 主题支持)
56+
57+
## 版本
58+
59+
### 1.0.0
60+
- 正式版本
61+
- 提供8款基础主题样式 `classic-bottom-two` `classic-bottom-three` `classic-right-two` `classic-right-three` `polaroid-bottom-two` `polaroid-bottom-three` `polaroid-right-two` `polaroid-right-three`相框
62+
- 提供裁剪工具 `crop`
63+
- exmaple 添加更多样例
64+
65+
### 0.1.0
66+
- 初始版本

‎packages/preview/polario-frame/1.0.0/src/export.typ‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#import "until.typ": crop
2+
#import "themes/basic/base.typ": *
3+
4+
#let render(size, flipped: false, img: image, theme: str, ext-info: (:)) = {
5+
import "until.typ": get-size
6+
let size = get-size(size, flipped: flipped)
7+
let rendering = eval("import \"themes/" + theme + ".typ\": *; rendering")
8+
rendering(size: size, img: img, ext-info: ext-info)
9+
}
10+

‎packages/preview/polario-frame/1.0.0/src/themes/basic/base.typ‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
#let extend-bottom(size:(0, 0), img: image, bottom: [], ratio: ratio, background: none) = {
2+
rect(width: size.at(0), height: size.at(1), inset: 0mm, outset: 0mm)[
3+
#grid(
4+
rows: (100% - ratio, ratio),
5+
fill: background,
6+
inset: 0mm,
7+
img,
8+
bottom,
9+
)
10+
]
11+
}
12+
13+
#let extend-top(size:(0, 0), img: image, bottom: [], ratio: ratio, background: none) = {
14+
rect(width: size.at(0), height: size.at(1), inset: 0mm, outset: 0mm)[
15+
#grid(
16+
rows: (ratio, 100% - ratio),
17+
fill: background,
18+
inset: 0mm,
19+
bottom,
20+
img,
21+
)
22+
]
23+
}
24+
25+
#let extend-right(size:(0, 0), img: image, right: [], ratio: fraction, background: none) = {
26+
rect(width: size.at(0), height: size.at(1), inset: 0mm, outset: 0mm)[
27+
#grid(
28+
columns: (100% - ratio, ratio),
29+
fill: background,
30+
inset: 0mm,
31+
img,
32+
right,
33+
)
34+
]
35+
}

0 commit comments

Comments
 (0)