shst-campus

v1.1.4

Published

2 years ago

shst campus

Downloads

0High
0Medium
0Low

touchczy

campus components

Campus

校园小程序组件库，uniapp-cli构建，主要是作为山科小站抽离的组件库依赖，请注意安装ts和sass的依赖，依赖包可以直接参考此版本库根目录下的package.json，迁移到TS以及处理作为小程序的依赖踩坑等相关信息请参考 uniapp小程序迁移到TS。

安装

安装shst-campus依赖。

$ yarn add shst-campus

uni-cli项目默认是不编译node_modules下的组件的，导致条件编译等功能失效，需要在根目录创建vue.config.js文件，增加shst-campus包的编译即可。

const path = require("path");

module.exports = {
    transpileDependencies: ["shst-campus"],
    configureWebpack: {
        resolve: {
            alias: {
                "@": path.join(__dirname, "./src"),
            },
        },
    },
};

此外需要安装sass以及sass-loader，sass-loader请使用低于@11.0.0的版本，[email protected]不支持[email protected]，TS相关依赖建议可以参考package.json，建议在vue create -p dcloudio/uni-preset-vue时直接选择typescript模板即可。

$ yarn add sass -D  
$ yarn add [email protected] -D

之后是天坑环节，在之前发布npm包的时候就有很多坑，可以参考上边的博客。这次的坑是，使用按需引入的方式，即类似于import { CCard } from "shst-campus";这种形式，如果在本地src中写页面使用的是装饰器的写法的话，是不能正常编译node_modules里的组件的，无论node_modules里的组件是TS还是普通vue组件都会出现这样的情况，这个问题在上边写的博客里写了这就是个大坑，即编译出来的产物是没有css文件以及js文件只有一个Component({})，如果使用的是Vue.extend的写法的话，又是能够正常编译node_modules里的组件，当然本地src编写的组件如果没有使用TS的话是没有问题的，所以现在是有三种解决方案，其实终极大招是写一个webpack loader，这个我在博客中实现过，考虑到通用性才最终没使用，要是实在顶不住了就完善一下直接上loader，至于为什么要写loader而不只是写一个plugin也可以看看博客，天坑。

src中组件使用装饰器写法，引入组件使用真实路径，即类似于import CCard from "shst-campus/lib/c-card/c-card.vue";。
src中组件使用Vue.extend写法，可以使用按需引入，即类似于import { CCard } from "shst-campus";。
src中组件使用这两种写法都可以，然后配置一下uniapp提供的easycom能力，之后可以直接使用组件不需要声明。

如果需要配置组件的按需引入，即类似于import { CCard } from "shst-campus";这种形式，需要修改babel.config.js文件。

// babel.config.js
// ...
process.UNI_LIBRARIES = process.UNI_LIBRARIES || ["@dcloudio/uni-ui"];
process.UNI_LIBRARIES.push("shst-campus");
process.UNI_LIBRARIES.forEach(libraryName => {
    plugins.push([
        "import",
        {
            libraryName: libraryName,
            customName: name => {
                return `${libraryName}/lib/${name}/${name}`;
            },
        },
        libraryName,
    ]);
});
// ...

如果需要使用easycom的引入形式，那么需要配置pages.json。

// pages.json
{
    "easycom": {
       "autoscan": true,
       "custom": {
            "^c-(.*)": "shst-campus/lib/c-$1/c-$1.vue"
       }
    },
    // ...
}

近来事情不多所以重写了之前提到的loader，如果使用按需加载的方式上边都可以忽略，只需要安装好依赖并且在vue.config.js中配置好就可以了，可以参考https://github.com/SHST-SDUST/SHST-UNI/。

$ yarn add -D uniapp-import-loader

// vue.config.js
const path = require("path");

module.exports = {
    configureWebpack: {
        // ...
        module: {
            rules: [
                {
                    test: /\.vue$/,
                    loader: "uniapp-import-loader", 
                    // import { CCard } from "shst-campus"; 
                    // => import CCard from "shst-campus/lib/c-card/c-card";
                    options: {
                        name: "shst-campus",
                        path: "lib",
                    },
                },
            ],
        },
        // ..
    },
};

最后在App.vue中引入相关的css即可。

<!-- ... -->
<style lang="scss">
@import "shst-campus/lib/styles/asse.css";
@import "shst-campus/lib/styles/iconfont.css";
@import "shst-campus/lib/styles/asse-style.scss";
/* ... */
</style>

课表组件

描述

示例: /pages/time-table/time-table.vue。

<template>
    <c-time-table-header
        :week="week"
        @previous="pre"
        @next="next"
        @refresh="refresh"
    ></c-time-table-header>
    <view class="a-hr"></view>
    <c-time-table-body :start="start" :week="week" :table="table"></c-time-table-body>
</template>

<script lang="ts">
import { Component, Vue } from "vue-property-decorator";
// 此处示例的引入方式是作为`npm`依赖包的引入方式，并非上述示例中的方式，其他组件同此处
import CTimeTableHeader from "shst-campus/lib/c-time-table-header/c-time-table-header.vue";
import CTimeTableBody from "shst-campus/lib/c-time-table-body/c-time-table-body.vue";
import { DefinedTableItem } from "shst-campus/lib/types/time-table";

@Component({
    components: { CTimeTableHeader, CTimeTableBody },
})
export default class TimeTable extends Vue {
    week: number = 3;
    start: string = "2021-08-30";
    table: Array<DefinedTableItem> = [
        { week: 1, serial: 1, className: "高等数学1-2", teacher: "测试1", classRoom: "J7-101" },
        { week: 2, serial: 3, className: "高等数学1-2", teacher: "测试2", classRoom: "J7-101" },
        { week: 1, serial: 5, className: "高等数学1-2", teacher: "测试3", classRoom: "J7-101" },
        { week: 1, serial: 3, className: "大学英语1-1", teacher: "测试4", classRoom: "J7-101" },
        { week: 3, serial: 3, className: "大学英语1-1", teacher: "测试5", classRoom: "J7-101" },
        { week: 3, serial: 3, className: "大学英语1-2", teacher: "测试6", classRoom: "J7-102" },
        { week: 3, serial: 4, className: "大学英语1-1", teacher: "测试7", classRoom: "J7-101" },
        { week: 2, serial: 2, className: "大学物理3-2", teacher: "测试8", classRoom: "J7-101" },
        { week: 5, serial: 1, className: "大学物理3-2", teacher: "测试9", classRoom: "J7-101" },
        { week: 5, serial: 3, className: "大学物理3-2", teacher: "测试0", classRoom: "J7-101" },
    ];

    refresh(): void {
        console.log("refresh");
    }

    pre(): void {
        console.log("previous");
    }

    next(): void {
        console.log("next");
    }
}
</script>

参数说明

week: 显示的周次。
term-start: 当前学期开学日期，指的是开学当日。
table: 课表数据，传入一个对象数组，每个对象指定一节课程。
@refresh: 刷新按钮触发事件处理函数。
@previous: 上一周次按钮触发事件处理函数。
@next: 下一周次按钮触发事件处理函数。

校历组件

描述

示例: /pages/calendar/calendar.vue

<template>
    <view>
        <c-calendar
            :term="term"
            :termStart="termStart"
            :weekCount="weekCount"
            :vacationWeek="vacationWeek"
            :workDay="workDay"
            :vacationDay="vacationDay"
        ></c-calendar>
    </view>
</template>

<script lang="ts">
import { Component, Vue } from "vue-property-decorator";
import CCalendar from "shst-campus/lib/c-calendar/c-calendar.vue";

@Component({
    components: { CCalendar },
})
export default class Calendar extends Vue {
    term: string = "2021-2022-1";
    termStart: string = "2021-08-30";
    weekCount: number = 26;
    vacationWeek: number = 21;
    workDay: Array<string> = ["2021-09-18", "2021-09-26"];
    vacationDay: Array<string> = ["2021-09-20", "2021-09-21"];
}
</script>

参数说明

term: 当前学期。
termStart: 开学日期，指的是开学当天。
weekCount: 该学期总周次，是包括假期在内的周次总数。
vacationWeek: 假期开始周次，一定是小于等于weekCount的。
workDay: 调休的工作日，例如2021-09-18是周六，中秋假期调休上班。
vacationDay: 假期，例如2021-09-20是周一，2021-09-21是周二，中秋假期休息。

校园导览组件

校园导览组件自项目 school-map 重写而来，组件的使用需要两步配置，第一步是编写配置文件，可以参考本项目的src/pages/tour/sdust.ts，实际上引入import { TourConfig } from "shst-campus/lib/types/tour"再根据类型编写即可，第二步是申请高德地图的key，用来完成路径规划功能，密钥申请地址http://lbs.amap.com/api/javascript-api/summary/，另外须加入https://restapi.amap.com为request合法域名，再之后就可以按照src/pages/tour/文件夹下类似的页面完成功能了。这其中的路由方式比较诡异，因为小程序端写类似这种需要跳转的组件比较难受，使用组件去完成路由体验又比较差，主要体现在返回前一页的，只能使用emit到父组件再进行路由了，所以需要多个页面来完成功能。

描述

示例: /pages/tour/tour.vue

<template>
    <CTour
        :school-map="map"
        :images="imagesPath"
        :init-location="initLocation"
        @nav-search="navSearch"
        @nav-detail="navDetail"
        @nav-route="navRoute"
    ></CTour>
</template>

<script lang="ts">
import { Component, Vue } from "vue-property-decorator";
import map from "./sdust";
import CTour from "@/components/c-tour/c-tour.vue";
import { TourConfig, MarkerImages, InitLocation } from "@/components/types/tour";

@Component({
    components: { CTour },
})
export default class Tour extends Vue {
    public map: TourConfig = map;
    public imagesPath: MarkerImages = {
        life: "/static/tour/life.png",
        dormitory: "/static/tour/dormitory.png",
        scenery: "/static/tour/scenery.png",
        canteen: "/static/tour/canteen.png",
        door: "/static/tour/door.png",
        building: "/static/tour/building.png",
        supermarket: "/static/tour/supermarket.png",
    };
    public initLocation: InitLocation = {
        latitude: 36.003,
        longitude: 120.1239,
    };

    public navSearch(): void {
        uni.navigateTo({ url: "./search" });
    }

    public navDetail(path: string): void {
        uni.navigateTo({ url: "./detail" + path });
    }

    public navRoute(path: string): void {
        uni.navigateTo({ url: "./route" + path });
    }
}
</script>

<style>
page {
    padding: 0;
}
</style>

参数说明

school-map: 符合TourConfig类型的对象。
images: 配置显示各种类别的图片绝对路径。
init-location: 初始加载过程中显示的地址。
@nav-search: 点击搜索按钮的事件。
@nav-detail: 点击跳转详情按钮的事件，参数path为详情页需要的数据。
@nav-route: 点击跳转路径规划按钮的事件，参数path为路径规划页需要的数据。

描述

示例: /pages/tour/search.vue

<template>
    <CTourSearch :school-map="map" @nav-detail="navDetail" @nav-route="navRoute"></CTourSearch>
</template>

<script lang="ts">
import { Component, Vue } from "vue-property-decorator";
import map from "./sdust";
import CTourSearch from "@/components/c-tour-search/c-tour-search.vue";
import { TourConfig } from "@/components/types/tour";

@Component({
    components: { CTourSearch },
})
export default class Tour extends Vue {
    public map: TourConfig = map;

    public navDetail(path: string): void {
        uni.navigateTo({ url: "./detail" + path });
    }

    public navRoute(path: string): void {
        uni.navigateTo({ url: "./route" + path });
    }
}
</script>

<style>
page {
    padding: 0;
}
</style>

参数说明

school-map: 符合TourConfig类型的对象。
@nav-detail: 点击跳转详情按钮的事件，参数path为详情页需要的数据。
@nav-route: 点击跳转路径规划按钮的事件，参数path为路径规划页需要的数据。

描述

示例: /pages/tour/detail.vue

<template>
    <CTourDetail :detail="detail" @nav-route="navRoute"></CTourDetail>
</template>

<script lang="ts">
import { Component, Vue } from "vue-property-decorator";
import map from "./sdust";
import CTourDetail from "@/components/c-tour-detail/c-tour-detail.vue";
import { SubItem } from "@/components/types/tour";

@Component({
    components: { CTourDetail },
})
export default class Detail extends Vue {
    public detail: SubItem | Record<string, never> = {};

    onLoad(options: { tIndex: string; dIndex: string }): void {
        const tabIndex = parseInt(options.tIndex);
        const dataIndex = parseInt(options.dIndex);
        this.detail = map[tabIndex].data[dataIndex];
    }

    public navRoute(path: string): void {
        uni.navigateTo({ url: "./route" + path });
    }
}
</script>

<style>
page {
    padding: 0;
}
</style>

参数说明

detail: 符合SubItem类型的对象，是TourConfig类型中实际显示的一条数据。
@nav-route: 点击跳转路径规划按钮的事件，参数path为路径规划页需要的数据。

描述

示例: /pages/tour/route.vue

<template>
    <CTourRoute
        map-key="填入高德地图开放平台申请的key"
        :images="imagesPath"
        :target-location="targetLocation"
    ></CTourRoute>
</template>

<script lang="ts">
import { Component, Vue } from "vue-property-decorator";
import CTourRoute from "@/components/c-tour-route/c-tour-route.vue";
import { RouteMarkerImages } from "@/components/types/tour";

@Component({
    components: { CTourRoute },
})
export default class Route extends Vue {
    public imagesPath: RouteMarkerImages = {
        start: "/static/tour/start.png",
        end: "/static/tour/end.png",
    };

    public targetLocation: { latitude: number; longitude: number } | Record<string, never> = {};

    onLoad(options: { latitude: string; longitude: string }): void {
        this.targetLocation = {
            latitude: parseFloat(options.latitude),
            longitude: parseFloat(options.longitude),
        };
    }
}
</script>

<style>
page {
    padding: 0;
}
</style>

参数说明

map-key: 高德地图开放平台申请的key，http://lbs.amap.com/api/javascript-api/summary/。
images: 配置显示各种类别的图片绝对路径。
target-location: 从path中取得的终点地址对象。

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Campus

安装

课表组件

描述

参数说明

校历组件

描述

参数说明

校园导览组件

描述

参数说明

描述

参数说明

描述

参数说明

描述

参数说明