Ga naar hoofdinhoud

Appt samples package gepubliceerd

We zijn verheugd om @appt.org/samples aan te kondigen, een nieuw NPM package dat codevoorbeelden biedt voor het bouwen van toegankelijke apps.

De package bevat meer dan 400 codevoorbeelden om toegankelijke apps te maken met Android (XML), Jetpack Compose, iOS (UIKit), SwiftUI, Flutter, React Native, .NET MAUI en Xamarin.

Abra heeft dit project gefinancierd en Mart-Jan Roeleveld (Q42) heeft de package geschreven.

Configuratie​

De package werkt met elk build system via onze loader interface. Het bevat ingebouwde ondersteuning voor Webpack.

npm install @appt.org/samples

Configureer je bundler, maak een loader aan en begin met zoeken:

import { createWebpackLoader, getTopic } from '@appt.org/samples';

// Create a webpack context that includes all markdown files
const webpackContext = require.context(
  '@appt.org/samples/samples',
  true, // Include subdirectories
  /\.md$/, // Only include markdown files
  'lazy' // Only load a sample when it is requested in retrieval
);

// Query code samples for `accessibility-label` on `android` and `ios`
const topic = await getTopic(loader, {
  locale: ['nl'],
  technique: 'accessibility-label',
  frameworks: ['android', 'ios']
});

De topic data kan worden gebruikt om de codevoorbeelden te renderen met het framework van je keuze.

  • topic.introduction bevat een Introduction object

  • topic.samples bevat alle Sample objecten

Rendering​

Ons CodeSample component toont hoe je deze codevoorbeelden kunt renderen met Docusaurus en React.

<CodeSample id="accessibility-label"/>

wordt gerenderd als:

Licenties​

Als stichting zonder winstoogmerk zijn we toegewijd om informatie over toegankelijkheid gratis en open-source te houden.

Het LICENSE bestand bevat licentie-informatie.

Bij het publiceren van onze inhoud of code moet je:

  • Adequate bronvermelding verstrekken zoals vereist door CC BY-SA 4.0 en MIT.

  • Een zichtbare link naar https://appt.org of https://github.com/appt-org/appt-samples opnemen op elke pagina waar onze content gebruikt wordt.

Als je niet kunt voldoen aan de vereisten, neem contact met ons op via info@appt.org om alternatieve licentieopties te bespreken, inclusief white-label.

Licentiekosten worden gebruikt om de collectie codevoorbeelden voor iedereen uit te breiden.

Bijdragen​

Help je ons mee om apps toegankelijker te maken?

Wanneer je bijdraagt, zal je naam zichtbaar zijn in de commit geschiedenis voor elk codevoorbeeld. In de toekomst gebruiken we dit om auteurs naast de codevoorbeelden te tonen op onze website.