@thisissoon/angular-post

A simple lightweight library to use Po.st social sharing widgets in Angular apps

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00Feb 6, 2019Jan 29, 2018Minified + gzip package size for @thisissoon/angular-post in KB

Readme

Angular Post

Build Status Coverage Status Commitizen friendly code style: prettier

A simple lightweight library to use Po.st social sharing widgets in Angular apps

This is a simple library for Angular, implemented in the Angular Package Format v5.0.

Install

via NPM

npm i @thisissoon/angular-post --save

via Yarn

yarn add @thisissoon/angular-post

app.module.ts

import { PostModule, Post } from '@thisissoon/angular-post';

const postProviders = [
  { provide: Post, useFactory: () => window['postPlatform'] },
];

@NgModule({
  imports: [PostModule.forRoot(postProviders)],
})
export class AppModule {}

index.html

Add the Po.st script to your index.html file inside your <head> tag as in their instructions

<script type="text/javascript">
  (function() {
    var s = document.createElement('script');
    s.type = 'text/javascript';
    s.async = true;
    s.src =
      ('https:' == document.location.protocol ? 'https://s' : 'http://i') +
      '.po.st/static/v4/post-widget.js#publisherKey=<REPLACE_WITH_ACCOUNT_ID>';
    var x = document.getElementsByTagName('script')[0];
    x.parentNode.insertBefore(s, x);
  })();
</script>

Example

A full working example can be found in the src/app folder.

app.component.html

<sn-post
  [widgetId]="'REPLACE_WITH_WIDGET_ID'"
  [url]="'https://foo.com'"
  [title]="'My Title'"
  [options]="{
    buttons: [
      { id: 'twitter' },
      { id: 'linkedin' },
      { id: 'facebook' }
    ],
    label: false,
    radius: 'square',
    size: 48,
    counter: false,
    layout: 'horizontal',
    jumbo: false,
    padding: false,
    view: 'auto',
    shareNewWindow: true
  }"
>
</sn-post>

Options

  • widgetId:(string): can be found in post widget settings
  • url(string): URL to share
  • title(string): title of post to share
  • options(object): options to pass on widget located here

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Making Commits

This repo uses Commitizen CLI and Conventional Changelog to create commits and generate changelogs. Instead of running git commit run git cz and follow the prompts. Changelogs will then be generated when creating new releases by running npm run release.

Making Releases

Run npm run release to create a new release. This will use Standard Version to create a new release. Standard Version will generate / update the changelog based on commits generated using Commitizen CLI, update the version number following semantic versioning rules and then commit and tag the commit for the release. Simply run git push --follow-tags origin master.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.