@ getmicdrop/ venue- calendar
与斯维尔特一起建造的用于展示喜剧事件的美丽而可定制的日历组件. 适合喜剧俱乐部、场地和活动组织者.
特征
✨ 6 个视图:日历、列表、画廊、木马、特色和今晚,加上8个外观
🎨 美丽的UI: 由 Tailwind CSS 构建的现代响应设计
📱 移动友好: Swipe手势,触摸最优化,反应快的设计
🔌 简单整合与React、Vue、vanilla JS等合作
🌐 一个脚本标签:自备捆绑-贴一 <script>,没有建设步骤
🎨 包含样式: 捆绑注入自己的 CSS — 没有单独的样式表可以链接
⚡ 自动月球: 自动查找并挂入指定的容器
🎯 可自定义: 配置视图、导航和更多
🌙 黑暗模式:内置光线,暗线和高相接主题
♿ 可访问: ARIA 标签,键盘导航,屏幕阅读器支持
🎫 状态:可视化徽章为"On sell","卖快","卖出"等
安装
添加一个 <script> 标记指向Micdrop托管的捆绑。 软件包是
私人(不在npm/jsDelivr上)——从 get-micdrop.com数字 :
<script
defer
src="https://get-micdrop.com/embed/venue-calendar.iife.js"
></script>
- 无样式表可链接 . 捆绑在运行时注入自己的CSS,所以
仅此而已的纯页
<script>使风格完整. - 使用
defer(或async)所以捆绑从不屏蔽页面解析. 没错 ~310 KB克齐普. - 在HTTPS上服务你的页面. 退出存储 a
Secure马车饼干,什么 萨法里在不安全的情况下下降(http://)页.
备注: 正在最后敲定确切的主机 URL (微投放票) 页:1 在开始直播前确认Micdrop的地址.
这个
import { ... } from '@getmicdrop/venue-calendar'实例 用于 Micdrop- 内部应用程序 与捆绑器并有登记簿 访问私人软件包。 公共网站(喜剧俱乐部等)<script>上方标记——不npm install。 。 。 .
快速启动
方法1:自动登月(最轻松)
随便加个分级 micdrop-calendar-container 并自动挂载日历 :
<!DOCTYPE html>
<html>
<head>
<title>My Comedy Club</title>
<!-- Preload the bundle while the page parses. defer keeps the
<script> non-blocking; preload starts the fetch earlier. -->
<link
rel="preload"
as="script"
href="https://get-micdrop.com/embed/venue-calendar.iife.js"
/>
<script
defer
src="https://get-micdrop.com/embed/venue-calendar.iife.js"
></script>
</head>
<body>
<!-- Calendar auto-mounts here. Use data-organization-id to show all of an
organization's shows, or data-venue-id for a single venue. -->
<div
class="micdrop-calendar-container"
data-organization-id="your-organization-id"
data-view="calendar"
data-show-view-options="true"
data-show-month-switcher="true"
data-locale="en-US"
></div>
</body>
</html>
方法2:网络组件
使用自定义 <micdrop-calendar> 元素 :
<!DOCTYPE html>
<html>
<head>
<title>My Comedy Club</title>
<script
defer
src="https://get-micdrop.com/embed/venue-calendar.iife.js"
></script>
</head>
<body>
<!-- Web Component -->
<micdrop-calendar
venue-id="your-venue-id"
view="calendar"
show-view-options="true"
show-month-switcher="true"
locale="en-US"
>
</micdrop-calendar>
</body>
</html>
方法 3: JavaScript API
对于更多的控制,请使用 JavaScript API :
<!DOCTYPE html>
<html>
<head>
<title>My Comedy Club</title>
</head>
<body>
<div id="my-calendar"></div>
<!-- Load the bundle, then call the global it exposes. -->
<script
defer
src="https://get-micdrop.com/embed/venue-calendar.iife.js"
></script>
<script>
window.addEventListener('load', function () {
window.VenueCalendar.initVenueCalendar({
target: '#my-calendar',
organizationId: 'your-organization-id',
view: 'calendar',
showViewOptions: true,
showMonthSwitcher: true,
});
});
</script>
</body>
</html>
框架整合
反应
import React, { useEffect, useRef } from 'react';
import { initVenueCalendar, unmount } from '@getmicdrop/venue-calendar';
function VenueCalendarComponent({ venueId, view = 'calendar' }) {
const calendarRef = useRef(null);
const instanceRef = useRef(null);
useEffect(() => {
if (!calendarRef.current) return;
instanceRef.current = initVenueCalendar({
target: calendarRef.current,
venueId,
view,
events: [],
showViewOptions: true,
showMonthSwitcher: true,
});
return () => {
// Svelte 5 — components mounted via `mount()` are destroyed via
// the `unmount` helper, not `.$destroy()` (that was Svelte 4).
if (instanceRef.current) {
try {
unmount(instanceRef.current);
} catch {}
instanceRef.current = null;
}
};
}, [venueId, view]);
return <div ref={calendarRef}></div>;
}
export default VenueCalendarComponent;
报告错误和运行时间配置
将部件所发现的任何错误连接到您现有的监视器中 :
import { configureVenueCalendar } from '@getmicdrop/venue-calendar';
configureVenueCalendar({
onError: (err, { source }) => {
Sentry.captureException(err, { tags: { source, micdrop: true } });
},
// Optional overrides for self-hosted backends or regional failover.
// apiBaseUrl: 'https://api.eu.micdrop.com',
// apiTimeout: 15000,
// apiRetries: 2,
});
对于临时支持诊断,部件会打开其版本
window数字 :
window.__MICDROP_CALENDAR__.version; // e.g. "3.6.23"
地点像素和访客同意:
如果您的组织保存了 Meta 像素或 Google 分析 4 ID, 日历 只有在访客同意后才能装入。 上面没有同意信号 完全不发送Meta或谷歌请求. 告诉它,访客答应了 任何人 这些方法:
<!-- your consent tool already said yes before the calendar loads -->
<div data-consent-granted="true" ...></div>
// from your cookie banner's "Accept" callback
window.__MICDROP_CALENDAR__.setConsentGranted(true);
一种使用IAB TCF API的认可工具(__tcfapi)被捡起
自动. data-consent-required="false" 告诉您的网站的日历
这些像素不需要同意;这是你自己的合法电话和访客
其浏览器发送全球隐私控制仍然没有像素 .
React App 中的用法 :
import React, { useState } from 'react';
import VenueCalendarComponent from './VenueCalendarComponent';
function App() {
const [venueId, setVenueId] = useState('comedy-club-123');
const [view, setView] = useState('calendar');
return (
<div style={{ padding: '20px' }}>
<h1>Event Viewer</h1>
<div style={{ marginBottom: '20px' }}>
<label>Venue ID:</label>
<input
type="text"
value={venueId}
onChange={e => setVenueId(e.target.value)}
/>
</div>
<div style={{ marginBottom: '20px' }}>
<label>Select View:</label>
<label>
<input
type="radio"
value="list"
checked={view === 'list'}
onChange={e => setView(e.target.value)}
/>
List
</label>
<label>
<input
type="radio"
value="gallery"
checked={view === 'gallery'}
onChange={e => setView(e.target.value)}
/>
Gallery
</label>
<label>
<input
type="radio"
value="calendar"
checked={view === 'calendar'}
onChange={e => setView(e.target.value)}
/>
Calendar
</label>
</div>
<VenueCalendarComponent venueId={venueId} view={view} />
</div>
);
}
export default App;
第3组
<template>
<div ref="calendarContainer"></div>
</template>
<script setup>
import { ref, onMounted, onUnmounted, watch } from 'vue';
import { initVenueCalendar } from '@getmicdrop/venue-calendar';
const props = defineProps({
venueId: String,
view: {
type: String,
default: 'calendar',
},
});
const calendarContainer = ref(null);
let calendarInstance = null;
onMounted(() => {
calendarInstance = initVenueCalendar({
target: calendarContainer.value,
venueId: props.venueId,
view: props.view,
events: [],
showViewOptions: true,
showMonthSwitcher: true,
});
});
onUnmounted(() => {
if (calendarInstance && calendarInstance.$destroy) {
calendarInstance.$destroy();
}
});
watch(
() => props.venueId,
newId => {
if (calendarInstance) {
calendarInstance.$destroy();
calendarInstance = initVenueCalendar({
target: calendarContainer.value,
venueId: newId,
view: props.view,
events: [],
showViewOptions: true,
showMonthSwitcher: true,
});
}
}
);
</script>
丝绒
<script>
import { VenueCalendar } from '@getmicdrop/venue-calendar';
import { Calendar, Grid, List } from 'carbon-icons-svelte';
import { writable } from 'svelte/store';
let venueId = 'your-venue-id';
let currentMonth = writable(new Date().getUTCMonth());
let currentYear = writable(new Date().getUTCFullYear());
function handleNext() {
currentMonth.update(m => m + 1);
}
function handlePrev() {
currentMonth.update(m => m - 1);
}
</script>
<VenueCalendar
showViewOptions={[
{ id: 0, text: 'List view', icon: List },
{ id: 1, text: 'Gallery view', icon: Grid },
{ id: 2, text: 'Calendar view', icon: Calendar },
]}
showMonthSwitcher={true}
events={[]}
{currentMonth}
{currentYear}
{handleNext}
{handlePrev}
on:eventClick={e => console.log('Event clicked:', e.detail)}
/>
主机页面道具——用于已经拥有部件所绘制部分内容的页面. 每一次默认, 所以嵌入不变:
| Prop | 类型 | 默认 | 说明 |
|---|---|---|---|
checkoutProbe | 布尔 | true | 询问本页面能否售出一票,并在无法售出时将"在线售票不在此提供"提示. false 跳过探测器,从不提取警报——对于一个没有购票的宿主,如站点建造者的设计帆布. |
showGiftCardsLink | 布尔 | true | Footers"出道卡"链接. false 对于一个主页,它自己的页脚已经携带它. |
showPoweredBy | 布尔 | true | 脚印"由米克滴出"标记. false 对于一个主页,它自己的页脚已经携带它. |
角质
import {
Component,
OnInit,
OnDestroy,
ElementRef,
ViewChild,
} from '@angular/core';
import { initVenueCalendar } from '@getmicdrop/venue-calendar';
@Component({
selector: 'app-venue-calendar',
template: '<div #calendarContainer></div>',
})
export class VenueCalendarComponent implements OnInit, OnDestroy {
@ViewChild('calendarContainer', { static: true })
calendarContainer!: ElementRef;
private calendarInstance: any;
ngOnInit() {
this.calendarInstance = initVenueCalendar({
target: this.calendarContainer.nativeElement,
venueId: 'your-venue-id',
view: 'calendar',
events: [],
showViewOptions: true,
showMonthSwitcher: true,
});
}
ngOnDestroy() {
if (this.calendarInstance && this.calendarInstance.$destroy) {
this.calendarInstance.$destroy();
}
}
}
配置选项
标记属性
下面的每个属性都在工作 <micdrop-calendar> * 载于e/cn.4/sub.2/2000/l.70号文件 data- 双向
(单位:千美元)data-view, (中文(简体) ), data-venue-id继续 <micdrop-calendar> 或自动挂载
<div class="micdrop-calendar-container">自动挂载 <div> 读取标记的
最后一栏中的"div";其余,使用 <micdrop-calendar> 或保存的部件.
| 属性 | 数值 | 默认 | 它会做什么 | 数字 |
|---|---|---|---|---|
venue-id | 地点代号 | 无 | 展出地点 | ✓ |
organization-id | 组织编号 | 无 | 展出地点所在的组织 | ✓ |
widget-id | 已保存部件 ID | 无 | 装入在 Micdrop 中保存的部件: 其视图、 过滤器、 颜色和显示选项; div 只使用其显示选项 | ✓ |
widget-key | 部件密钥 | 无 | 让部件从不属于Micdrop 的站点读取其显示 | ✓ |
view | 见 视图 | calendar | 部件打开的视图 | ✓ |
show-view-options | true 编号 : false | true | 绘制视图切换器 | ✓ |
show-month-switcher | true 编号 : false | true | 绘制月箭头 | ✓ |
show-search | true 编号 : false | 与切换器 | 绘制搜索框; true 画它时没有切换器, false 藏起来 | |
show-powered-by | true 编号 : false | true | 在部件下绘制“ 由 Micdrop 授权” 一行 | ✓ |
show-background | true 编号 : false | true | 绘制部件本身的画布和外置; false 直接放在页面上 | |
max-items | 正整数 | 全部 | 显示 Gallery 、 List 和 Carousel 绘图的次数 | |
skip-items | 整数 | 0 | 第一批名单中有多少显示名单的外观(look-list, (中文(简体) ), look-board(删除) | |
event-details | JSON,比如说. {"date":false} | 全部开始 | 哪些卡片部件绘制( W)poster, (中文(简体) ), date, (中文(简体) ), description页:1 false 隐藏一个 | |
size | S 编号 : M 编号 : L | M | 每个视图的显示大小 | |
heading-level | 1 编号 : 2 | 1 | 屏幕阅读器标题的级别; 2 当页面已经有自己的 h1 | ✓ |
poster-fit | fit 编号 : fill | fit | 整张海报,或者装入盒子 | ✓ |
poster-backdrop | blur 编号 : color | blur | {\fn黑体\fs22\bord1\shad0\3aHBE\4aH00\fscx67\fscy66\2cHFFFFFF\3cH808080}什么是满满的 fit 海报 | ✓ |
inject-seo | true 编号 : false | true | 打开一个节目设定页面标题并分享该节目的预览,关闭后恢复 | ✓ |
url-mode | pushState 编号 : none | pushState | none 保持部件不更改页面地址( 对于 Iframe 和 Wix 嵌入) | ✓ |
locale | 语言标记,例如:. en-US | 浏览器设置 | 部件所绘制的语言和日期格式 | ✓ |
api-base | 来源,例如:. https://get-micdrop.com | 磁盘的 API | 部件读取其显示的地方 | ✓ |
public-site-origin | 来源 | api-base | 共享链接、事件页和礼品卡链接点 | ✓ |
consent-required | true 编号 : false | 自动检测 | 对于非TCF cookie 横幅: 暂停跟踪直至同意 | ✓ |
consent-granted | true 编号 : false | 自动检测 | 非TCF饼干旗:访客已同意 | ✓ |
A 类 true编号 :false 属性在存在时( o)show-search 或者说 show-search=""只关闭
作为 ="false"。不解析的值会被忽略,部件会保留默认值.
JavaScript API 选项
initVenueCalendar({
target: '.my-calendar', // CSS selector or HTMLElement (required)
venueId: 'venue-123', // Venue ID (optional)
view: 'calendar', // any view name under Views (default: 'calendar')
events: [], // Array of event objects (default: [])
showViewOptions: true, // Show view switcher (default: true)
showMonthSwitcher: true, // Show month navigation (default: true)
});
事件对象结构
{
id: 'event-123',
name: 'Comedy Night',
date: '2024-10-25T20:00:00Z',
image: 'https://example.com/image.jpg',
status: 'On Sale',
timeline: '8:00 PM - 10:00 PM',
// ... other fields
}
视图
view 取出6个视图名称之一,或8个外观之一.
| 视图 | 它画的是什么 |
|---|---|
calendar | 默认: 每月显示网格 |
list | 即将在垂直列表中显示 |
gallery | 一组展出海报 |
carousel | 在一行中滚动侧向显示 |
featured | 一出大戏 |
tonight | 今天的节目,如董事会所看到的 |
哪个视图
第一场比赛获胜:
?view=在页面地址中,当它命名一个视图时。 风景切换器写在那里,所以一个访客自己选取的和共享的链接都赢了.- 保存的视图
<micdrop-calendar widget-id>。 。 。 . - 这个
view属性. calendar。 。 。 .
属性和已保存的部件
打开 <micdrop-calendar widget-id>,标签上的属性胜过部件保存的显示选项: show-search, (中文(简体) ), show-view-options, (中文(简体) ), show-powered-by, (中文(简体) ), show-background, (中文(简体) ), event-details, (中文(简体) ), max-items, (中文(简体) ), skip-items 财务报告和审定财务报表 size。保存的视图是例外:它取代 view。 。 。 .
外观
外观是其卡片部件和大小设定的视图,是Micdrop部件构建器的起点.
| 视图 | 听着 |
|---|---|
look-featured | 特性: 一个显示为叠卡 |
look-ticket | 入场券:一个展出,日期设定大 |
look-strip | 脱: 每行一出 |
look-list | 清单:按当天分组的节目 |
look-board | 棋盘: 由每个表演时间牵头的列表 |
look-grid | 网格: 在网格中显示牌 |
look-posters | 海报墙:仅海报 |
look-calendar | 日历: 一个月网格 |
WordPress 整合
对于WordPress站点,您可以将此添加到您的页面/后 HTML 中:
<div
class="micdrop-calendar-container"
data-venue-id="your-venue-id"
data-view="calendar"
></div>
<script src="https://get-micdrop.com/embed/venue-calendar.iife.js"></script>
或将脚本添加到您主题的页脚上,并在内容中任意使用div.
样式
该日历带有使用Tailwind CSS的内置样式. 如果您需要自定义外观,您可以覆盖 CSS 类或添加自己的样式.
/* Example: Custom styling */
.micdrop-calendar-container {
max-width: 1200px;
margin: 0 auto;
padding: 20px;
}
说明: 挂载目标不能是一个收缩到适应的盒子(display: inline-block, (中文(简体) ), float, (中文(简体) ), position: absolute, (中文(简体) ), display: table-cell,或弹性行中的自动宽项。 日历将其打字图大小改为自己的容器,这就需要挂载目标从母体获得它的宽度——一个正常的块元素(如上所举的每一个例子)是完全正确的. 如果日历检测到一个收缩到适应的挂载目标,它会倒回到页面宽度类型的缩放并记录一个控制台警告.
他们
该日历支持通过 CSS 自定义属性和JavaScript 公用功能进行综合主题.
使用 CSS 自定义属性
通过设置 CSS 自定义属性来覆盖默认主题 :
/* Custom brand colors */
.micdrop-calendar-container {
--brand-primary-fill: 270 76% 40%; /* Purple: buttons, today, tints */
--brand-primary: 270 76% 40%; /* Links and outlines; must read on the page */
--text-primary: 0 0% 10%;
--bg-primary: 0 0% 100%;
}
/* Dark mode */
.dark .micdrop-calendar-container,
[data-theme='dark'] .micdrop-calendar-container {
--brand-primary-fill: 270 76% 70%;
--brand-primary: 270 76% 70%;
--text-primary: 0 0% 95%;
--bg-primary: 0 0% 10%;
}
可用的 CSS 变量
| 变量 | 说明 | 默认( 亮) |
|---|---|---|
--brand-primary-fill | 文本后品牌颜色: 按钮 | 209 99% 44.5% |
--brand-primary | 品牌颜色作为文本:链接、大纲 | 209 99% 41.5% |
--text-primary | 主要文字颜色 | 0 0% 0% |
--text-secondary | 副文本 | 0 0% 40% |
--bg-primary | 主要背景 | 0 0% 100% |
--bg-secondary | 二级背景 | 0 0% 98% |
--stroke-primary | 边框颜色 | 0 0% 80% |
--status-on-sale | "出售"的徽章 | 217 91% 60% |
--status-selling-fast | "卖快"徽章 | 38 92% 50% |
--status-sold-out | "卖出"徽章 | 0 84% 60% |
--today-bg | 今天的日期背景 | 217 91% 97% |
--focus-ring | 键盘焦点环 | 217 91% 60% |
设定两个品牌变量: 按钮读取 --brand-primary-fill 一个人,所以
仅高于 --brand-primary 默认蓝色的已填充控件 .
applyTheme 设置填充及其文本颜色.
使用 JavaScript 主题工具
import {
applyTheme,
themes,
generateThemeCSS,
} from '@getmicdrop/venue-calendar';
// Apply a preset theme
applyTheme(themes.dark);
// Apply to a specific container
const container = document.querySelector('.micdrop-calendar-container');
applyTheme(themes.dark, container);
// Create a custom theme
const myTheme = {
brandPrimary: '270 76% 60%', // Purple
textPrimary: '0 0% 10%',
bgPrimary: '0 0% 100%',
statusOnSale: '142 71% 45%', // Green for on sale
};
applyTheme(myTheme);
// Generate CSS string for embedding
const cssString = generateThemeCSS(myTheme);
console.log(cssString);
// Output: :root { --brand-primary: 270 76% 60%; ... }
预设主题
框外包括三个主题:
import { themes } from '@getmicdrop/venue-calendar';
// Light theme (default)
applyTheme(themes.light);
// Dark theme
applyTheme(themes.dark);
// High contrast (accessibility)
applyTheme(themes.highContrast);
自动黑暗模式
日历自动尊重用户的系统偏好 :
/* Automatically applied when user prefers dark mode */
@media (prefers-color-scheme: dark) {
/* Dark theme variables are applied */
}
您也可以手动切换暗模式 :
<!-- Add 'dark' class to enable dark theme -->
<div class="dark">
<div class="micdrop-calendar-container" data-venue-id="123"></div>
</div>
<!-- Or use data-theme attribute -->
<div data-theme="dark">
<div class="micdrop-calendar-container" data-venue-id="123"></div>
</div>
本地化和 CDN 捆绑
日历和退票会讲13种语言. 英语被载入 捆绑;其他12个是 运行时获取,一个文件,仅用于 当地语言实际上在使用——所以买家从不下载十二种语言读取一种语言. 这是将CDN捆绑在~594 KB gziped 而不是~686 KB 上的原因.
对 npm 软件包来说, 不需要什么: 您的捆绑器代码分割目录 并解决他们自己.
给 <script> 嵌入后,捆绑会从哪里找
它本身从并装入的 URL 版本绑定的兄弟姐妹数字 :
https://get-micdrop.com/embed/venue-calendar.iife.js
https://get-micdrop.com/embed/locales/<version>/main/es.js ← calendar copy
https://get-micdrop.com/embed/locales/<version>/flow/es.js ← checkout copy
日历本身的载荷相同. venue-calendar.iife.js 是一个小
加载器:它取来第一块(足以绘制保存的外观卡)并,
一旦卡片被取出,剩下的部件,都来自一个版本固定
looks/<version>/ 旁边的目录 直到其他人装上子弹
window.VenueCalendar 函数返回决心实现
函数返回;之后是函数本身.
如果你自负的包, 复制 dist/locales/, (中文(简体) ), dist/looks/ 财务报告和审定财务报表
dist/checkout-libs/ 与之并列的目录。 。 。 .
版本被绑定的路径意味着新发布只会添加文件;它们永远不会覆盖
旧的捆绑用的目录.
当无法获取时
如果无法装入 locale 文件—— 允许列表的内容- 安全政策
准确的脚本文件而不是来源,离线的 CDN,或者
<script type="module"> 嵌入到捆绑无法看到它自己的 URL 的地方 ——
日历只保留英文。 无出错和无出错; 部件
和英国买家一样 制作和出售机票.
日历本身的文件是一个不同的问题:如果 looks/<version>/ 无法
被装入, 无绘图, 而控制台为失败的文件命名 。 两者
修改 URL 大小写下面的覆盖; 内容- 安全政策必须允许
get-micdrop.com/embed/ 目录,其中没有文件 .
当它无法解决时,有两种方法可以指向正确的地方:
<!-- Option A: tell it before the bundle loads -->
<script>
window.__MICDROP_CALENDAR_ASSET_BASE__ = 'https://get-micdrop.com/embed/';
</script>
<script
defer
src="https://get-micdrop.com/embed/venue-calendar.iife.js"
></script>
<!-- Option B: put it on the tag -->
<script
defer
src="https://get-micdrop.com/embed/venue-calendar.iife.js"
data-vc-base="https://get-micdrop.com/embed/"
></script>
defer 财务报告和审定财务报表 async 不需要覆盖 – 经典脚本仍然知道自己的 URL .
第一幅画总是英文
非英国买家在冷货上看到英语片刻,页面互换 当目录到来时, 这是有意的:日历 刻画而非等待翻译文件.
浏览器支持
- 颜色( 最新)
- 火狐( 最新)
- 萨法里(最新)
- 边缘( 最新)
- 移动浏览器(iOS Safari, Chrome Mobile)
发展
构建软件包
# Install dependencies
npm install
# Build the library
npm run build:lib
# Development mode (SvelteKit app)
npm run dev
# Preview production build
npm run preview
build:lib 3个通行证和命令事项: IIFE通行证先行
拥有 dist/ 擦擦 ES/UMD通过附件
vite.config.locales.js 附加运行时间本地目录
(单位:千美元)dist/locales/<version>/{main,flow}/<tag>.js最后一个. npm run size 如果失败
捆绑及其目录 并非都出自于此.
项目结构
venue-calendar/
├── src/
│ ├── components/ # Svelte components
│ │ ├── Calendar/
│ │ ├── CalendarContainer/
│ │ └── Button/
│ ├── lib/ # Library entry points
│ │ ├── VenueCalendar.js
│ │ └── web-component.js
│ └── routes/ # SvelteKit routes (for dev)
├── dist/ # Built package (generated)
│ └── locales/<version>/ # Runtime locale catalogues for the CDN bundle
├── package.json
├── vite.config.lib.js # Library build config (ES/UMD + IIFE passes)
├── vite.config.locales.js # Emits the runtime locale catalogues
└── README.md
锁定文件策略
package-lock.json 是单一的 Cononical 锁文件—— CI 和 发布
工作流程安装 npm ci不执行 yarn.lock 或者说
pnpm-lock.yaml (两相相取相. 本地dev 机器可能使用 pnpm 来进行
svelte-组件会链接工作流程,但依赖性变化必须降落在
package-lock.json 通过npm.
API 参考
initVenueCalendar(options)
初始化日历实例 .
参数:
options(目标):配置选项
回返情况: Svelte 组件实例
示例
const calendar = initVenueCalendar({
target: '#calendar',
venueId: 'venue-123',
view: 'calendar',
});
autoMount()
自动将日历挂载到有类的所有元素 micdrop-calendar-container。 。 。 .
示例
import { autoMount } from '@getmicdrop/venue-calendar';
autoMount();
构成部分活动
日历组件显示您可以收听的事件 :
const calendar = initVenueCalendar({
target: '#calendar',
// ... other options
});
// Listen to component events (if using Svelte component directly)
calendar.$on('eventClick', event => {
console.log('Event clicked:', event.detail);
});
解决问题
日历未显示
- 检查脚本已装入: 打开浏览器控制台并校验无出错
- 验证容器存在: 确保目标元素存在于 DOM 中
- 检查数据属性:确保正确格式化属性
data-前缀
不应用的样式
- 未装入 CSS:样式被捆绑在JS文件中并自动注入——不需要单独的样式表
- CSS 冲突:检查其他样式是否压倒日历样式
- 没有装入: 确认
<script src>micdrop 寄托的捆绑和返回200分(不是404分)
未显示的事件
- 检查事件数据格式: 确保事件符合预期结构
- 日期格式: 对日期使用 ISO 8601 格式 (
YYYY-MM-DDTHH:mm:ssZ(中文(简体) ) - 地点标识: 校验会场标识正确
许可证
专有. 版权 (c)2026 Micdrop. 版权所有。 见 自由主义。 。 。 .
支助
关于问题、问题或专题请求,请访问: https://github.com/get-micdrop/venue-calendar/issues (中文(简体) )
由MicDrop团队制作