❤
npm
Sign UpSign In

This package has been deprecated

Author message:

outdated and not maintained

fundamental-vue

0.18.3 • Public • Published

Fundamental Vue

npm version Minified Size Minzipped Size Build Status Coverage Status Slack

Description

The fundamental-vue library is a set of Vue.js components built using SAP Fiori Fundamentals.

The SAP Fiori Fundamentals library is a design system and HTML/CSS component library used to build modern product user experiences with the SAP look and feel.

API Reference

See Component Documentation for examples and API details.

Requirements

To download and use Fundamental Vue library, you first need to install the node package manager. https://www.npmjs.com/get-npm

Some prior knowledge of Vue is required for using this library.

Getting started

Fundamental Vue in 5 Minutes or less

Paste the following snippet in your <head>-tag:

<link
    rel="stylesheet"
    href="https://unpkg.com/fiori-fundamentals@latest/dist/fiori-fundamentals.min.css"
/>
<script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script>
<script src="https://unpkg.com/fundamental-vue@latest/dist/FundamentalVue.umd.js"></script>

Then you can use Fundamental Vue like this:

<div id="app">
  <fd-popover v-fd-margin:large placement="bottom-start" with-arrow>
    <h1 v-fd-margin:large>
      🚀 Hello Fundamental Vue 🚀
    </h1>
    <template #control="{toggle}">
      <fd-button @click="toggle">Show Popover</fd-button>
    </template>
  </fd-popover>
</div>
 
<script>new Vue({ el: '#app' })</script>

When using Fundamental Vue via a <script>-tag you don't have to install it manually by calling Vue.use(FundamentalVue). This is done for you automatically. You can disable the automatic installation by setting window.__FD_AUTO_INSTALL_DISABLED_KEY__ to true early on.

If you are targeting IE 11 you have to include the IE-compatible build of Fiori Fundamentals:

<link rel="stylesheet" type="text/css" href="https://unpkg.com/fiori-fundamentals@latest/dist/fiori-fundamentals-ie11.min.css">

How to install Fundamental Vue via NPM is described below.

Install

To download and use this library, you first need to install the node package manager - npm.

  1. Install Fundamental Vue

    NPM

    $ npm install --save fundamental-vue

    After installing, you will need to import fundamental-vue and make it available to your Vue application. These instructions assume the usage of Vue CLI to scaffold your project.

    In your project's main.js:

    import FundamentalVue from 'fundamental-vue';
    Vue.use(FundamentalVue);
    // …

    Fundamental Vue does not include the 'Fiori Fundamentals' library which is required for styling.

  2. Install Fiori Fundamentals

    The quickest way to get Fiori Fundamentals styling for your components is to include the compiled and minified Fiori Fundamentals CSS library with the following CDN link in your public index.html file:

    <link rel="stylesheet" type="text/css" href="https://unpkg.com/fiori-fundamentals@latest/dist/fiori-fundamentals.min.css">

    However, installing the Fiori Fundamentals library with npm (recommended) will give you the flexibility to use individual components and enable advanced customisation options. In this case, you do not need the CDN link as this method uses the SASS/SCSS source.

    To install the Fiori Fundamentals SASS/SCSS source:

    $ npm install --save fiori-fundamentals

    The following assumes the usage of a module bundler such as webpack. To compile Fiori Fundamentals SASS/SCSS to CSS, two additional packages are required for your bundling process - sass-loader and node-sass. To install these packages as development dependencies:

    $ npm install sass-loader node-sass --save-dev

    Loading the SCSS and running your project at this point will result in errors relating to the path configuration for icons and fonts. This is a known issue.

    To rectify this, start by creating a new directory ('scss') in your project's src. Within this directory, create a main SCSS file ('main.scss') from which to manage your imports, configurations and customisations.

    Add the following to the main SCSS file:

    // If you are targeting IE 11 uncomment the following line. 
    // $fd-support-css-var-fallback: true; 
    // should be declared before the scss import 
    $fd-icons-path : "../node_modules/fiori-fundamentals/scss/icons/";
    $fd-scss-font-path : "../node_modules/fiori-fundamentals/scss/fonts/";
    @import "../node_modules/fiori-fundamentals/scss/all.scss";

    Import the main SCSS file in your App.js style block to add Fiori Fundamentals styles to your project.

    <style lang='scss'>
    @import "./scss/main.scss";
    // … 
    </style>

    You can now use the Documentation to browse the components currently available with Fundamental Vue.

    To use a Fundamental Vue component, paste the desired code snippet from the Playground and configure it as necessary:

    <fd-alert dismissible>
        Happy building! 🚀
    </fd-alert>

Versioning

The fundamental-vue library follows Semantic Versioning. These components strictly adhere to the [MAJOR].[MINOR].[PATCH] numbering system (also known as [BREAKING].[FEATURE].[FIX]).

Merges to the master branch will be published as a prerelease. Prereleases will include an rc version (e.g. [MAJOR].[MINOR].[PATCH]-rc.[RC]).

Known Issues

Please see Issues.

Developer Guide

Interested in contributing to this Fundamental Vue? See the Developer Guide.

Testing Guide

See the Testing Guide.

Support

If you encounter an issue, you can create a ticket

Contributing

If you want to contribute, please check the Developer Guide documentation for contribution guidelines.

Check out this guide on building a new component for the library and creating the necessary documentation for your new component.

License

Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file

Similar Projects

Readme

Keywords

Package Sidebar

Install

npm i fundamental-vue

Repository

github.com/SAP/fundamental-vue

Homepage

sap.github.io/fundamental-vue

Weekly Downloads

111

Version

0.18.3

License

Apache-2.0

Unpacked Size

4.25 MB

Total Files

1408

Last publish

Collaborators

  • fundamental-ui
Try on RunKit
Report malware