DC Elections Visualization

Visualization project for DC Elections, starting in 2022.

Built by Andrew Turner in collaboration with Greater Greater Washington.

Using Components

First, include the components source files

<script type="module" src="./../build/dc-election.esm.js"></script>
<script nomodule src="./../build/dc-election.js"></script>

Then in your HTML you can add the components with a survey filename URL and optional title:

<dc-election-survey id="housing" filename="./../assets/housing.csv">
  <h2 slot="title">Housing</h2>
</dc-election-survey>

Surveys

Surveys are a CSV file, primarily with the schema:

Photo,Candidate,Race,_Preface_ Question 1,_Preface_ Question 2, ...
Nadeau.jpg,Brianne Nadeau,Ward 1,1. Yes,1. Yes,1. Yes,1. Yes,1. Yes,Guaranteed headways of 10 minutes or less within D.C.
Harris.jpg,Sabel Harris,Ward 1,1. Yes,1. Yes,1. Yes,1. Yes,1. Yes,Guaranteed headways of 10 minutes or less within D.C.

Formatting

You can use underscores to de-emphasize questions: _Policy says.._ Do you support?

Ordering

You can order responses by prefix answers with a number, like 1. Yes or 2. No.

The number will sort responses but will not be displayed in the results.

Getting Started

To start building a new web component using Stencil, clone this repo to a new directory:

git clone https://github.com/ajturner/dc-elections.git
cd dc-elections

and run:

npm install
npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

Developers

Stencil

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all.

Naming Components

When creating new component tags, we recommend not using stencil in the component name (ex: <stencil-datepicker>). This is because the generated component has little to nothing to do with Stencil; it's just a web component!

Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix ion.

Using this component

There are three strategies we recommend for using web components built with Stencil.

The first step for all three of these strategies is to publish to NPM.

Script tag

Put a script tag similar to this <script type='module' src='https://unpkg.com/my-component@0.0.1/dist/my-component.esm.js'></script> in the head of your index.html
Then you can use the element anywhere in your template, JSX, html etc

Node Modules

Run npm install my-component --save
Put a script tag similar to this <script type='module' src='node_modules/my-component/dist/my-component.esm.js'></script> in the head of your index.html
Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

Run npm install my-component --save
Add an import to the npm packages import my-component;
Then you can use the element anywhere in your template, JSX, html etc