Skip to content

Commit 0a7a789

Browse files
committed
Update readme.md
1 parent b4802e2 commit 0a7a789

File tree

1 file changed

+116
-116
lines changed

1 file changed

+116
-116
lines changed

readme.md

Lines changed: 116 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -149,122 +149,122 @@ var qrcode = new QRCode(options);
149149

150150
```JS
151151
var options = {
152-
// ====== Basic
153-
text: "https://github.com/ushelp/EasyQRCodeJS",
154-
width: 256,
155-
height: 256,
156-
colorDark : "#000000",
157-
colorLight : "#ffffff",
158-
correctLevel : QRCode.CorrectLevel.H, // L, M, Q, H
159-
160-
// ====== dotScale
161-
/*
162-
dotScale: 1, // For body block, must be greater than 0, less than or equal to 1. default is 1
163-
164-
dotScaleTiming: 1, // Dafault for timing block , must be greater than 0, less than or equal to 1. default is 1
165-
dotScaleTiming_H: undefined, // For horizontal timing block, must be greater than 0, less than or equal to 1. default is 1
166-
dotScaleTiming_V: undefined, // For vertical timing block, must be greater than 0, less than or equal to 1. default is 1
167-
168-
dotScaleA: 1, // Dafault for alignment block, must be greater than 0, less than or equal to 1. default is 1
169-
dotScaleAO: undefined, // For alignment outer block, must be greater than 0, less than or equal to 1. default is 1
170-
dotScaleAI: undefined, // For alignment inner block, must be greater than 0, less than or equal to 1. default is 1
171-
*/
172-
173-
// ====== Quiet Zone
174-
/*
175-
quietZone: 0,
176-
quietZoneColor: "rgba(0,0,0,0)",
177-
*/
178-
179-
// ====== Logo
180-
/*
181-
logo: "../demo/logo.png", // Relative address, relative to `easy.qrcode.min.js`
182-
logo: "http://127.0.0.1:8020/easy-qrcodejs/demo/logo.png",
183-
logoWidth: 80, // fixed logo width. default is `width/3.5`
184-
logoHeight: 80, // fixed logo height. default is `heigth/3.5`
185-
logoMaxWidth: undefined, // Maximum logo width. if set will ignore `logoWidth` value
186-
logoMaxHeight: undefined, // Maximum logo height. if set will ignore `logoHeight` value
187-
logoBackgroundColor: '#fffff', // Logo backgroud color, Invalid when `logBgTransparent` is true; default is '#ffffff'
188-
logoBackgroundTransparent: false, // Whether use transparent image, default is false
189-
*/
190-
191-
// ====== Backgroud Image
192-
/*
193-
backgroundImage: '', // Background Image
194-
backgroundImageAlpha: 1, // Background image transparency, value between 0 and 1. default is 1.
195-
autoColor: false, // Automatic color adjustment(for data block)
196-
autoColorDark: "rgba(0, 0, 0, .6)", // Automatic color: dark CSS color
197-
autoColorLight: "rgba(255, 255, 255, .7)", // Automatic color: light CSS color
198-
*/
199-
200-
// ====== Colorful
201-
// === Posotion Pattern(Eye) Color
202-
/*
203-
PO: '#e1622f', // Global Posotion Outer color. if not set, the defaut is `colorDark`
204-
PI: '#aa5b71', // Global Posotion Inner color. if not set, the defaut is `colorDark`
205-
PO_TL:'', // Posotion Outer color - Top Left
206-
PI_TL:'', // Posotion Inner color - Top Left
207-
PO_TR:'', // Posotion Outer color - Top Right
208-
PI_TR:'', // Posotion Inner color - Top Right
209-
PO_BL:'', // Posotion Outer color - Bottom Left
210-
PI_BL:'', // Posotion Inner color - Bottom Left
211-
*/
212-
// === Alignment Color
213-
/*
214-
AO: '', // Alignment Outer. if not set, the defaut is `colorDark`
215-
AI: '', // Alignment Inner. if not set, the defaut is `colorDark`
216-
*/
217-
// === Timing Pattern Color
218-
/*
219-
timing: '#e1622f', // Global Timing color. if not set, the defaut is `colorDark`
220-
timing_H: '', // Horizontal timing color
221-
timing_V: '', // Vertical timing color
222-
*/
223-
224-
// ====== Title
225-
/*
226-
title: 'QR Title', // content
227-
titleFont: "normal normal bold 18px Arial", //font. default is "bold 16px Arial"
228-
titleColor: "#004284", // color. default is "#000"
229-
titleBackgroundColor: "#fff", // background color. default is "#fff"
230-
titleHeight: 70, // height, including subTitle. default is 0
231-
titleTop: 25, // draws y coordinates. default is 30
232-
*/
233-
234-
// ====== SubTitle
235-
/*
236-
subTitle: 'QR subTitle', // content
237-
subTitleFont: "normal normal normal 14px Arial", // font. default is "14px Arial"
238-
subTitleColor: "#004284", // color. default is "4F4F4F"
239-
subTitleTop: 40, // draws y coordinates. default is 0
240-
*/
241-
242-
// ===== Event Handler
243-
/*
244-
onRenderingStart: undefined,
245-
*/
246-
247-
// ==== Images format
248-
/*
249-
format: 'PNG', // 'PNG', 'JPG'
250-
compressionLevel: 6, // ZLIB compression level (0-9). default is 6
251-
quality: 0.75, // An object specifying the quality (0 to 1). default is 0.75. (JPGs only)
252-
*/
253-
254-
// ==== Versions
255-
/*
256-
version: 0, // The symbol versions of QR Code range from Version 1 to Version 40. default 0 means automatically choose the closest version based on the text length.
257-
*/
258-
259-
// ===== Binary(hex) data mode
260-
/*
261-
binary: false, // Whether it is binary mode, default is text mode.
262-
*/
263-
264-
// ===== UTF-8 without BOM
265-
/*
266-
utf8WithoutBOM: true
267-
*/
152+
// ====== Basic
153+
text: "https://github.com/ushelp/EasyQRCodeJS",
154+
width: 256,
155+
height: 256,
156+
colorDark : "#000000",
157+
colorLight : "#ffffff",
158+
correctLevel : QRCode.CorrectLevel.H, // L, M, Q, H
159+
160+
// ====== dotScale
161+
/*
162+
dotScale: 1, // For body block, must be greater than 0, less than or equal to 1. default is 1
163+
164+
dotScaleTiming: 1, // Dafault for timing block , must be greater than 0, less than or equal to 1. default is 1
165+
dotScaleTiming_H: undefined, // For horizontal timing block, must be greater than 0, less than or equal to 1. default is 1
166+
dotScaleTiming_V: undefined, // For vertical timing block, must be greater than 0, less than or equal to 1. default is 1
167+
168+
dotScaleA: 1, // Dafault for alignment block, must be greater than 0, less than or equal to 1. default is 1
169+
dotScaleAO: undefined, // For alignment outer block, must be greater than 0, less than or equal to 1. default is 1
170+
dotScaleAI: undefined, // For alignment inner block, must be greater than 0, less than or equal to 1. default is 1
171+
*/
172+
173+
// ====== Quiet Zone
174+
/*
175+
quietZone: 0,
176+
quietZoneColor: "rgba(0,0,0,0)",
177+
*/
178+
179+
// ====== Logo
180+
/*
181+
logo: "../demo/logo.png", // Relative address, relative to `easy.qrcode.min.js`
182+
logo: "http://127.0.0.1:8020/easy-qrcodejs/demo/logo.png",
183+
logoWidth: 80, // fixed logo width. default is `width/3.5`
184+
logoHeight: 80, // fixed logo height. default is `heigth/3.5`
185+
logoMaxWidth: undefined, // Maximum logo width. if set will ignore `logoWidth` value
186+
logoMaxHeight: undefined, // Maximum logo height. if set will ignore `logoHeight` value
187+
logoBackgroundColor: '#fffff', // Logo backgroud color, Invalid when `logBgTransparent` is true; default is '#ffffff'
188+
logoBackgroundTransparent: false, // Whether use transparent image, default is false
189+
*/
190+
191+
// ====== Backgroud Image
192+
/*
193+
backgroundImage: '', // Background Image
194+
backgroundImageAlpha: 1, // Background image transparency, value between 0 and 1. default is 1.
195+
autoColor: false, // Automatic color adjustment(for data block)
196+
autoColorDark: "rgba(0, 0, 0, .6)", // Automatic color: dark CSS color
197+
autoColorLight: "rgba(255, 255, 255, .7)", // Automatic color: light CSS color
198+
*/
199+
200+
// ====== Colorful
201+
// === Posotion Pattern(Eye) Color
202+
/*
203+
PO: '#e1622f', // Global Posotion Outer color. if not set, the defaut is `colorDark`
204+
PI: '#aa5b71', // Global Posotion Inner color. if not set, the defaut is `colorDark`
205+
PO_TL:'', // Posotion Outer color - Top Left
206+
PI_TL:'', // Posotion Inner color - Top Left
207+
PO_TR:'', // Posotion Outer color - Top Right
208+
PI_TR:'', // Posotion Inner color - Top Right
209+
PO_BL:'', // Posotion Outer color - Bottom Left
210+
PI_BL:'', // Posotion Inner color - Bottom Left
211+
*/
212+
// === Alignment Color
213+
/*
214+
AO: '', // Alignment Outer. if not set, the defaut is `colorDark`
215+
AI: '', // Alignment Inner. if not set, the defaut is `colorDark`
216+
*/
217+
// === Timing Pattern Color
218+
/*
219+
timing: '#e1622f', // Global Timing color. if not set, the defaut is `colorDark`
220+
timing_H: '', // Horizontal timing color
221+
timing_V: '', // Vertical timing color
222+
*/
223+
224+
// ====== Title
225+
/*
226+
title: 'QR Title', // content
227+
titleFont: "normal normal bold 18px Arial", //font. default is "bold 16px Arial"
228+
titleColor: "#004284", // color. default is "#000"
229+
titleBackgroundColor: "#fff", // background color. default is "#fff"
230+
titleHeight: 70, // height, including subTitle. default is 0
231+
titleTop: 25, // draws y coordinates. default is 30
232+
*/
233+
234+
// ====== SubTitle
235+
/*
236+
subTitle: 'QR subTitle', // content
237+
subTitleFont: "normal normal normal 14px Arial", // font. default is "14px Arial"
238+
subTitleColor: "#004284", // color. default is "4F4F4F"
239+
subTitleTop: 40, // draws y coordinates. default is 0
240+
*/
241+
242+
// ===== Event Handler
243+
/*
244+
onRenderingStart: undefined,
245+
*/
246+
247+
// ==== Images format
248+
/*
249+
format: 'PNG', // 'PNG', 'JPG'
250+
compressionLevel: 6, // ZLIB compression level (0-9). default is 6
251+
quality: 0.75, // An object specifying the quality (0 to 1). default is 0.75. (JPGs only)
252+
*/
253+
254+
// ==== Versions
255+
/*
256+
version: 0, // The symbol versions of QR Code range from Version 1 to Version 40. default 0 means automatically choose the closest version based on the text length.
257+
*/
258+
259+
// ===== Binary(hex) data mode
260+
/*
261+
binary: false, // Whether it is binary mode, default is text mode.
262+
*/
263+
264+
// ===== UTF-8 without BOM
265+
/*
266+
utf8WithoutBOM: true
267+
*/
268268
}
269269
```
270270

0 commit comments

Comments
 (0)