Gathering detailed insights and metrics for @dpc-sdp/yourvic-example-site
Gathering detailed insights and metrics for @dpc-sdp/yourvic-example-site
Installations
npm install @dpc-sdp/yourvic-example-siteDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
11.15.0
NPM Version
lerna/3.19.0/node@v11.15.0+x64 (win32)
Releases
Unable to fetch releases
Languages
5
Vue
JavaScript
MDX
HTML
SCSS
Vue (37.69%)
JavaScript (30.02%)
MDX (29.52%)
HTML (1.83%)
SCSS (0.93%)
Developer
dpc-sdp
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
Apache-2.0 License
5 Stars
440 Commits
1 Forks
11 Watchers
106 Branches
41 Contributors
Updated on Apr 29, 2025
Maintainers
4
Package Meta Information
Latest Version
1.1.3-next.9
Package Id
@dpc-sdp/yourvic-example-site@1.1.3-next.9
Unpacked Size
74.03 kB
Size
12.17 kB
File Count
8
NPM Version
lerna/3.19.0/node@v11.15.0+x64 (win32)
Node Version
11.15.0
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Table of Contents
- About the Project
- Component Overview
- Installation
- Usage
- Component Listing
- Deployment
- Data Hosting
- Contributing
- Support
- License
- Attribution
About The Project
The My Victoria component library aims to enable the publication of accessible maps, charts and user interface (UI) elements to websites by content owners across Government. It includes a set of reusable UI components designed to integrate with DDI’s existing ecosystem of platforms and services; and supporting documentation and examples to assist with their usage.
All components have been designed to align to Victorian Government design standards and branding; and include features to improve their accessibility.
For a higher level overview of how to get started, see the Getting Started Guide
Component Overview
All components have been developed with Vue as part of the MyVic-Components repository and aligned to the existing Ripple component library. Components are published to NPM, ready to be used directly in any Vue JS application.
Vue CLI is recommended for bootstrapping a new standalone Vue JS application.
Ripple includes example Vue JS and Nuxt sites that can be used to bootstrap a web application for deployment to SDP.
Storybook examples with component documentation are available here
Installation
Installation is straightforward with NPM or Yarn. See the component listing for all available packages.
1npm install @dpc-sdp/myvic-bar-chart --save
or
1yarn add @dpc-sdp/myvic-bar-chart
Usage
All components are published to NPM as individual packages under the @dpc-sdp namespace, with a myvic- prefix. For example:
- @dpc-sdp/myvic-map-core
- @dpc-sdp/myvic-bar-chart
Components are intended to be used with Vue.js projects, and can be installed with NPM as follows:
1npm install @dpc-sdp/myvic-map-core --save
And imported using ES6 style imports:
1import { MyvicMapCore } from '@dpc-sdp/myvic-map-core'
Or using require as follows:
1const MyvicMapCore = require("@dpc-sdp/myvic-map-core")
Or imported directly into an HTML page (see the UMD Bundle documentation for more information:
1<script src="https://cdn.jsdelivr.net/npm/@dpc-sdp/myvic-bundle@dev/dist/myvic-bundle.js"></script>
Component Listing
Auto Complete
A component for displaying an autocomplete search with results. This component renders a text input that allows searching over a set of items. The filtered results will appear beneath the input as a selectable list.
Address Search
A component for looking up addresses in Victoria using an autocomplete search.
Area Search
A component for looking up different kinds of areas using an autocomplete search.
Bar Chart
A component for displaying a data-driven bar chart.
Line Chart
A component for displaying a data-driven line chart.
Pie Chart
A component for displaying a data-driven pie chart.
Tree Map
A component for displaying a data-driven tree map.
Data Block
A component for displaying a single data item as a block element.
Toggle List
A component for displaying a dynamic list of toggleable items.
Map
An interactive map component based on OpenLayers.
Map - Tile Layer
A component that provides support for OSM, XYZ, WMS and ArcGIS tiled map layers.
Map - Vector Layer
A component that provides support for vector sources such as WFS, ArcGIS Feature Server and GeoJSON files.
Map - Vector Tile Layer
A component that provides support for Mapbox Vector Tile sources.
Global
Shared styles, libraries and utility functions for use across MyVictoria components.
Bundled Examples
Examples showing how multiple components can be bundled together and interact with each other.
UMD Bundle
A bundle of MyVictoria components packaged as a UMD. Mainly intended for use in existing HTML sites that are not already using Vue or Webpack.
Deployment
Users of the My Victoria components are responsible for arranging their own web hosting. Some possible options include:
- A Standalone Vue or Nuxt app can be self hosted on any standard web server.
- Existing SDP Sites may be able to use the components via Drupal and Data Driven Component
- A New SDP Site
- Non Vue.js site using the UMD bundle
Data Hosting
The My Victoria components don't have any specific requirements for data hosting, other than that the data is online and can be parsed with JavaScript. If hosting is required, some existing options include:
- MyVictoria (using Geoserver for hosting geospatial web services)
- Data.Vic
- API Gateway
Contributing
Check our CONTRIBUTING.md
Support
Digital Engagement, Department of Premier and Cabinet, Victoria, Australia is a maintainer of this package.
License
Distributed under the Apache 2.0 License. See LICENSE for more information.
Attribution
Single Digital Presence offers government agencies an open and flexible toolkit to build websites quickly and cost-effectively.
No vulnerabilities found.
No security vulnerabilities found.