0.1.7-sky-update-readme.0 • Published 3 years ago

@yieldx/embed v0.1.7-sky-update-readme.0

Weekly downloads
-
License
-
Repository
-
Last release
3 years ago

@yieldx/embed

JS and TS Utilities for integrating with YieldX Embedded Apps

Install

With npm:

npm install @yieldx/embed --save

With yarn

yarn add -E @yieldx/embed

Pure browser support

openYieldxEmbed is exported by @yieldx/embed

openYieldxEmbed will configure the embedded app and inject it into the page

If a dom identifier is passed to the configuration option container, the iframe will be added to that element

openYieldxEmbed({
  app: "inpaas",
  token: "eyadsfvva....asdf",
  sessionId: "3d301cd5-032c-a0bb-6880-7fabdcd81066",
  institutionId: "a67a2495-de2d-273c-4613-ca32828448f1",
  theme: {
    primary:"#179e83",
    background:"rgb(37, 45, 59)",
    foreground: "#334d5c",
    textPrimary: "rgb(255, 255, 255)",
    textSecondary: "#14a3d7"
  },
  mode: "sandbox"
})

Using React

This is the new and preferred approach for integrating with Plaid Link in React.

import React from "react";
import { useYieldxEmbed } from "@yieldx/embed";

export function App() {

  const url = useYieldxEmbed({
    theme: {
      primary:"#179e83",
      background:"rgb(37, 45, 59)",
      foreground: "#334d5c",
      textPrimary: "rgb(255, 255, 255)",
      textSecondary: "#14a3d7"
    },
    app: "inpaas",
    token: "eyadsfvva....asdf",
    sessionId: "3d301cd5-032c-a0bb-6880-7fabdcd81066",
    institutionId: "a67a2495-de2d-273c-4613-ca32828448f1",
    mode: "sandbox"
  });

  return (
    <iframe src={url} title="yieldx-embed"/>
  );
}

export default App;

All available configuration options

Please refer to the official YieldX docs for a more holistic understanding of the various Link options.

// src/lib/url-builder/url-builder.ts
type OptionalConfiguration = {
  token: string;
  sessionId: string;
  institutionId: string;
  // optional
  app?: string; /* default: inpaas */
  theme?: WhiteLabelOptions;
  mode?: 'sandbox' | 'production';
  frameId?: string;
  container?: string;
  onCompleted?: (status: string, message: string) => void
  onError?: (status: string, message: string) => void
};

type WhiteLabelOptions = {
  primary?: string;
  secondary?: string;
  background?: string;
  foreground?: string;
  textPrimary?: string;
  textSecondary?: string;
};

Typescript support

Typescript definitions for @yieldx/embed are built into the npm packge.

Test index.html

<html>

<head>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/qs/6.10.1/qs.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/postmate@1.5.2/build/postmate.min.js"></script>
    <script src="https://dp16xhm4dg09a.cloudfront.net/embed.umd.js"></script>
</head>

<body>
    <script>
        function onCompleted() {
            alert("Success")
        }
        function onError() {
            alert("An error occured")
        }
        function onLoad() {
            alert("An error occured")
        }
        Embed.openYieldxEmbed({
            token: "...",
            institutionId: "...",
            sessionId: "...",
            onCompleted,
            onError,
            onLoad
        })
    </script>
</body>

</html>
0.1.598

3 years ago

0.1.477

3 years ago

0.1.597

3 years ago

0.1.476

3 years ago

0.1.479

3 years ago

0.1.478

3 years ago

0.1.594

3 years ago

0.1.473

3 years ago

0.1.593

3 years ago

0.1.472

3 years ago

0.1.596

3 years ago

0.1.475

3 years ago

0.1.595

3 years ago

0.1.474

3 years ago

0.1.590

3 years ago

0.1.592

3 years ago

0.1.471

3 years ago

0.1.591

3 years ago

0.1.470

3 years ago

0.1.488

3 years ago

0.1.487

3 years ago

0.1.489

3 years ago

0.1.484

3 years ago

0.1.483

3 years ago

0.1.486

3 years ago

0.1.485

3 years ago

0.1.480

3 years ago

0.1.482

3 years ago

0.1.481

3 years ago

0.1.499

3 years ago

0.1.498

3 years ago

0.1.495

3 years ago

0.1.494

3 years ago

0.1.497

3 years ago

0.1.496

3 years ago

0.1.491

3 years ago

0.1.490

3 years ago

0.1.493

3 years ago

0.1.492

3 years ago

0.1.558

3 years ago

0.1.437

3 years ago

0.1.557

3 years ago

0.1.436

3 years ago

0.1.439

3 years ago

0.1.559

3 years ago

0.1.438

3 years ago

0.1.554

3 years ago

0.1.433

3 years ago

0.1.553

3 years ago

0.1.556

3 years ago

0.1.435

3 years ago

0.1.555

3 years ago

0.1.434

3 years ago

0.1.550

3 years ago

0.1.552

3 years ago

0.1.551

3 years ago

0.1.569

3 years ago

0.1.448

3 years ago

0.1.568

3 years ago

0.1.447

3 years ago

0.1.449

3 years ago

0.1.565

3 years ago

0.1.444

3 years ago

0.1.564

3 years ago

0.1.443

3 years ago

0.1.567

3 years ago

0.1.446

3 years ago

0.1.566

3 years ago

0.1.445

3 years ago

0.1.561

3 years ago

0.1.440

3 years ago

0.1.560

3 years ago

0.1.563

3 years ago

0.1.442

3 years ago

0.1.562

3 years ago

0.1.441

3 years ago

0.1.459

3 years ago

0.1.579

3 years ago

0.1.458

3 years ago

0.1.576

3 years ago

0.1.455

3 years ago

0.1.575

3 years ago

0.1.454

3 years ago

0.1.578

3 years ago

0.1.457

3 years ago

0.1.577

3 years ago

0.1.456

3 years ago

0.1.572

3 years ago

0.1.451

3 years ago

0.1.571

3 years ago

0.1.450

3 years ago

0.1.574

3 years ago

0.1.453

3 years ago

0.1.573

3 years ago

0.1.452

3 years ago

0.1.570

3 years ago

0.1.469

3 years ago

0.1.587

3 years ago

0.1.466

3 years ago

0.1.586

3 years ago

0.1.465

3 years ago

0.1.589

3 years ago

0.1.468

3 years ago

0.1.588

3 years ago

0.1.467

3 years ago

0.1.583

3 years ago

0.1.462

3 years ago

0.1.582

3 years ago

0.1.461

3 years ago

0.1.585

3 years ago

0.1.464

3 years ago

0.1.584

3 years ago

0.1.463

3 years ago

0.1.581

3 years ago

0.1.460

3 years ago

0.1.580

3 years ago

0.1.507

3 years ago

0.1.506

3 years ago

0.1.509

3 years ago

0.1.508

3 years ago

0.1.514

3 years ago

0.1.513

3 years ago

0.1.516

3 years ago

0.1.515

3 years ago

0.1.510

3 years ago

0.1.512

3 years ago

0.1.511

3 years ago

0.1.518

3 years ago

0.1.517

3 years ago

0.1.519

3 years ago

0.1.525

3 years ago

0.1.524

3 years ago

0.1.527

3 years ago

0.1.526

3 years ago

0.1.521

3 years ago

0.1.520

3 years ago

0.1.523

3 years ago

0.1.522

3 years ago

0.1.529

3 years ago

0.1.528

3 years ago

0.1.536

3 years ago

0.1.535

3 years ago

0.1.538

3 years ago

0.1.537

3 years ago

0.1.532

3 years ago

0.1.531

3 years ago

0.1.534

3 years ago

0.1.533

3 years ago

0.1.530

3 years ago

0.1.539

3 years ago

0.1.547

3 years ago

0.1.546

3 years ago

0.1.549

3 years ago

0.1.548

3 years ago

0.1.543

3 years ago

0.1.542

3 years ago

0.1.545

3 years ago

0.1.544

3 years ago

0.1.541

3 years ago

0.1.540

3 years ago

0.1.600

3 years ago

0.1.503

3 years ago

0.1.502

3 years ago

0.1.505

3 years ago

0.1.504

3 years ago

0.1.501

3 years ago

0.1.500

3 years ago

0.1.7

3 years ago

0.1.239

4 years ago

0.1.359

3 years ago

0.1.238

4 years ago

0.1.356

3 years ago

0.1.235

4 years ago

0.1.355

3 years ago

0.1.234

4 years ago

0.1.358

3 years ago

0.1.237

4 years ago

0.1.357

3 years ago

0.1.236

4 years ago

0.1.352

3 years ago

0.1.231

4 years ago

0.1.351

3 years ago

0.1.230

4 years ago

0.1.354

3 years ago

0.1.233

4 years ago

0.1.353

3 years ago

0.1.232

4 years ago

0.1.350

3 years ago

0.1.249

4 years ago

0.1.367

3 years ago

0.1.246

4 years ago

0.1.366

3 years ago

0.1.245

4 years ago

0.1.369

3 years ago

0.1.248

4 years ago

0.1.368

3 years ago

0.1.247

4 years ago

0.1.363

3 years ago

0.1.242

4 years ago

0.1.362

3 years ago

0.1.241

4 years ago

0.1.365

3 years ago

0.1.244

4 years ago

0.1.364

3 years ago

0.1.243

4 years ago

0.1.361

3 years ago

0.1.240

4 years ago

0.1.360

3 years ago

0.1.378

3 years ago

0.1.257

4 years ago

0.1.377

3 years ago

0.1.256

4 years ago

0.1.259

4 years ago

0.1.379

3 years ago

0.1.258

4 years ago

0.1.374

3 years ago

0.1.253

4 years ago

0.1.373

3 years ago

0.1.252

4 years ago

0.1.376

3 years ago

0.1.255

4 years ago

0.1.375

3 years ago

0.1.254

4 years ago

0.1.370

3 years ago

0.1.372

3 years ago

0.1.251

4 years ago

0.1.371

3 years ago

0.1.250

4 years ago

0.1.389

3 years ago

0.1.268

4 years ago

0.1.388

3 years ago

0.1.267

4 years ago

0.1.269

4 years ago

0.1.385

3 years ago

0.1.264

4 years ago

0.1.384

3 years ago

0.1.263

4 years ago

0.1.387

3 years ago

0.1.266

4 years ago

0.1.386

3 years ago

0.1.265

4 years ago

0.1.381

3 years ago

0.1.260

4 years ago

0.1.380

3 years ago

0.1.383

3 years ago

0.1.262

4 years ago

0.1.382

3 years ago

0.1.261

4 years ago

0.1.309

3 years ago

0.1.429

3 years ago

0.1.308

3 years ago

0.1.316

3 years ago

0.1.315

3 years ago

0.1.318

3 years ago

0.1.317

3 years ago

0.1.312

3 years ago

0.1.432

3 years ago

0.1.311

3 years ago

0.1.314

3 years ago

0.1.313

3 years ago

0.1.431

3 years ago

0.1.310

3 years ago

0.1.430

3 years ago

0.1.319

3 years ago

0.1.327

3 years ago

0.1.206

4 years ago

0.1.326

3 years ago

0.1.205

4 years ago

0.1.329

3 years ago

0.1.208

4 years ago

0.1.328

3 years ago

0.1.207

4 years ago

0.1.323

3 years ago

0.1.202

4 years ago

0.1.322

3 years ago

0.1.201

4 years ago

0.1.325

3 years ago

0.1.204

4 years ago

0.1.324

3 years ago

0.1.203

4 years ago

0.1.321

3 years ago

0.1.200

4 years ago

0.1.320

3 years ago

0.1.209

4 years ago

0.1.338

3 years ago

0.1.217

4 years ago

0.1.337

3 years ago

0.1.216

4 years ago

0.1.219

4 years ago

0.1.339

3 years ago

0.1.218

4 years ago

0.1.334

3 years ago

0.1.213

4 years ago

0.1.333

3 years ago

0.1.212

4 years ago

0.1.336

3 years ago

0.1.215

4 years ago

0.1.335

3 years ago

0.1.214

4 years ago

0.1.330

3 years ago

0.1.332

3 years ago

0.1.211

4 years ago

0.1.331

3 years ago

0.1.210

4 years ago

0.1.349

3 years ago

0.1.228

4 years ago

0.1.348

3 years ago

0.1.227

4 years ago

0.1.229

4 years ago

0.1.345

3 years ago

0.1.224

4 years ago

0.1.344

3 years ago

0.1.223

4 years ago

0.1.347

3 years ago

0.1.226

4 years ago

0.1.346

3 years ago

0.1.225

4 years ago

0.1.341

3 years ago

0.1.220

4 years ago

0.1.340

3 years ago

0.1.343

3 years ago

0.1.222

4 years ago

0.1.342

3 years ago

0.1.221

4 years ago

0.1.404

3 years ago

0.1.403

3 years ago

0.1.406

3 years ago

0.1.405

3 years ago

0.1.400

3 years ago

0.1.402

3 years ago

0.1.401

3 years ago

0.1.408

3 years ago

0.1.407

3 years ago

0.1.409

3 years ago

0.1.415

3 years ago

0.1.414

3 years ago

0.1.417

3 years ago

0.1.416

3 years ago

0.1.411

3 years ago

0.1.410

3 years ago

0.1.413

3 years ago

0.1.412

3 years ago

0.1.419

3 years ago

0.1.418

3 years ago

0.1.426

3 years ago

0.1.305

3 years ago

0.1.425

3 years ago

0.1.304

3 years ago

0.1.428

3 years ago

0.1.307

3 years ago

0.1.427

3 years ago

0.1.306

3 years ago

0.1.422

3 years ago

0.1.301

3 years ago

0.1.421

3 years ago

0.1.300

3 years ago

0.1.424

3 years ago

0.1.303

3 years ago

0.1.423

3 years ago

0.1.302

3 years ago

0.1.420

3 years ago

0.1.190

4 years ago

0.1.192

4 years ago

0.1.191

4 years ago

0.1.198

4 years ago

0.1.197

4 years ago

0.1.199

4 years ago

0.1.194

4 years ago

0.1.193

4 years ago

0.1.196

4 years ago

0.1.195

4 years ago

0.1.390

3 years ago

0.1.279

4 years ago

0.1.158

4 years ago

0.1.399

3 years ago

0.1.278

4 years ago

0.1.157

4 years ago

0.1.159

4 years ago

0.1.396

3 years ago

0.1.275

4 years ago

0.1.154

4 years ago

0.1.395

3 years ago

0.1.274

4 years ago

0.1.153

4 years ago

0.1.398

3 years ago

0.1.277

4 years ago

0.1.156

4 years ago

0.1.397

3 years ago

0.1.276

4 years ago

0.1.155

4 years ago

0.1.392

3 years ago

0.1.271

4 years ago

0.1.391

3 years ago

0.1.270

4 years ago

0.1.394

3 years ago

0.1.273

4 years ago

0.1.152

4 years ago

0.1.393

3 years ago

0.1.272

4 years ago

0.1.280

4 years ago

0.1.169

4 years ago

0.1.289

4 years ago

0.1.168

4 years ago

0.1.286

4 years ago

0.1.165

4 years ago

0.1.285

4 years ago

0.1.164

4 years ago

0.1.288

4 years ago

0.1.167

4 years ago

0.1.287

4 years ago

0.1.166

4 years ago

0.1.282

4 years ago

0.1.161

4 years ago

0.1.281

4 years ago

0.1.160

4 years ago

0.1.284

4 years ago

0.1.163

4 years ago

0.1.283

4 years ago

0.1.162

4 years ago

0.1.291

4 years ago

0.1.170

4 years ago

0.1.290

4 years ago

0.1.179

4 years ago

0.1.297

3 years ago

0.1.176

4 years ago

0.1.296

3 years ago

0.1.175

4 years ago

0.1.299

3 years ago

0.1.178

4 years ago

0.1.298

3 years ago

0.1.177

4 years ago

0.1.293

3 years ago

0.1.172

4 years ago

0.1.292

3 years ago

0.1.171

4 years ago

0.1.295

3 years ago

0.1.174

4 years ago

0.1.294

3 years ago

0.1.173

4 years ago

0.1.181

4 years ago

0.1.180

4 years ago

0.1.187

4 years ago

0.1.186

4 years ago

0.1.189

4 years ago

0.1.188

4 years ago

0.1.183

4 years ago

0.1.182

4 years ago

0.1.185

4 years ago

0.1.184

4 years ago

0.1.147

4 years ago

0.1.149

4 years ago

0.1.148

4 years ago

0.1.150

4 years ago

0.1.151

4 years ago

0.1.118

4 years ago

0.1.119

4 years ago

0.1.129

4 years ago

0.1.128

4 years ago

0.1.125

4 years ago

0.1.124

4 years ago

0.1.127

4 years ago

0.1.126

4 years ago

0.1.121

4 years ago

0.1.120

4 years ago

0.1.123

4 years ago

0.1.122

4 years ago

0.1.139

4 years ago

0.1.136

4 years ago

0.1.135

4 years ago

0.1.138

4 years ago

0.1.137

4 years ago

0.1.132

4 years ago

0.1.131

4 years ago

0.1.134

4 years ago

0.1.133

4 years ago

0.1.130

4 years ago

0.1.146

4 years ago

0.1.143

4 years ago

0.1.142

4 years ago

0.1.145

4 years ago

0.1.144

4 years ago

0.1.141

4 years ago

0.1.140

4 years ago

0.1.117

4 years ago

0.1.114

4 years ago

0.1.113

4 years ago

0.1.116

4 years ago

0.1.115

4 years ago

0.1.110

4 years ago

0.1.112

4 years ago

0.1.111

4 years ago

0.1.107

4 years ago

0.1.106

4 years ago

0.1.109

4 years ago

0.1.108

4 years ago

0.1.103

4 years ago

0.1.105

4 years ago

0.1.104

4 years ago

0.1.102

4 years ago

0.1.101

4 years ago

0.1.100

4 years ago

0.1.96

4 years ago

0.1.97

4 years ago

0.1.98

4 years ago

0.1.99

4 years ago

0.1.95

4 years ago

0.1.93

4 years ago

0.1.94

4 years ago

0.1.90

4 years ago

0.1.91

4 years ago

0.1.92

4 years ago

0.1.88

4 years ago

0.1.89

4 years ago

0.1.87

4 years ago

0.1.85

4 years ago

0.1.86

4 years ago

0.1.80

4 years ago

0.1.81

4 years ago

0.1.82

4 years ago

0.1.83

4 years ago

0.1.84

4 years ago

0.1.74

4 years ago

0.1.75

4 years ago

0.1.76

4 years ago

0.1.77

4 years ago

0.1.78

4 years ago

0.1.79

4 years ago

0.1.70

4 years ago

0.1.71

4 years ago

0.1.72

4 years ago

0.1.73

4 years ago

0.1.68

4 years ago

0.1.69

4 years ago

0.1.67

4 years ago

0.1.63

4 years ago

0.1.64

4 years ago

0.1.65

4 years ago

0.1.66

4 years ago

0.1.62

4 years ago

0.1.52

4 years ago

0.1.53

4 years ago

0.1.54

4 years ago

0.1.55

4 years ago

0.1.56

4 years ago

0.1.57

4 years ago

0.1.58

4 years ago

0.1.59

4 years ago

0.1.50

4 years ago

0.1.51

4 years ago

0.1.49

4 years ago

0.1.44

4 years ago

0.1.45

4 years ago

0.1.46

4 years ago

0.1.47

4 years ago

0.1.48

4 years ago

0.1.60

4 years ago

0.1.61

4 years ago

0.1.41

4 years ago

0.1.42

4 years ago

0.1.43

4 years ago

0.1.40

4 years ago

0.1.38

4 years ago

0.1.39

4 years ago

0.1.32

4 years ago

0.1.33

4 years ago

0.1.34

4 years ago

0.1.35

4 years ago

0.1.36

4 years ago

0.1.37

4 years ago

0.1.30

4 years ago

0.1.31

4 years ago

0.1.27

4 years ago

0.1.28

4 years ago

0.1.29

4 years ago

0.1.22

4 years ago

0.1.23

4 years ago

0.1.24

4 years ago

0.1.25

4 years ago

0.1.26

4 years ago

0.1.20

4 years ago

0.1.21

4 years ago

0.1.16

4 years ago

0.1.17

4 years ago

0.1.18

4 years ago

0.1.19

4 years ago

0.1.13

4 years ago

0.1.14

4 years ago

0.1.15

4 years ago

0.1.10

4 years ago

0.1.11

4 years ago

0.1.12

4 years ago

0.1.8

4 years ago

0.1.9

4 years ago

0.0.16

4 years ago

0.0.17

4 years ago

0.0.18

4 years ago

0.0.14

4 years ago

0.0.15

4 years ago

0.0.12

4 years ago

0.0.13

4 years ago

0.0.10

4 years ago

0.0.11

4 years ago

0.0.9

4 years ago

0.0.8

4 years ago

0.0.5

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago