sp-dev-fx-webparts/samples/vuejs-todo-single-file-comp.../README.md

5.9 KiB

page_type products languages extensions
sample
office-sp
javascript
typescript
contentType technologies createdDate
tools
SharePoint Framework
1/1/2016 12:00:00 AM

Todo Client with Vue.js and Vue's single-file components

Summary

Sample Todo web part demonstrating how you can utilize Vue (a progressive framework for building user interfaces) with SharePoint Framework using handy single-file components approach.

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

SPFx 1.10 Node.js LTS 10 | LTS 8 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Compatible Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Solution

Solution Author(s)
vuejs-todo-single-file-component Sergei Sergeev (@sergeev_srg), Dimcho Tsanov (Singens)

Version history

Version Date Comments
0.0.1 January 27, 2017 Initial version.
0.0.2 March 30, 2017 Updated to GA
0.0.3 June 14, 2017 Fix webpack 2 issues
0.0.4 October 7, 2017 Updated packages to latest versions, misc fixing
0.0.5 November 15, 2017 Added data provider that demonstrates the CRUD operations
0.0.6 December 11, 2018 Updated sample to SPFx 1.4 and Vue 2.5.x
0.0.7 April 28, 2020 Updated sample to SPFx 1.10 and Vue 2.6.x, fixed issues with batch loader
0.0.8 April 4, 2022 Replace node sass with sass

Minimal Path to Awesome

  • Clone this repo
  • In the command line run:
    • npm i
    • gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Features

Demonstrates\uses below features:

  • integration between third party frontend framework Vue.js and SharePoint Framework
  • build pipeline customization
  • custom build pipeline tasks
  • modern component-based architecture
  • separation of concerns between markup, styling and code
  • single-file components architecture for Vue.js
  • custom webpack loaders

Help

We do not support samples, but we this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.